PowerShell/src/System.Management.Automation/help/SyntaxHelpInfo.cs

/********************************************************************++
Copyright (c) Microsoft Corporation.  All rights reserved.
--********************************************************************/

namespace System.Management.Automation
{
    /// <summary>
    /// 
    /// Class HelpFileHelpInfo keeps track of help information to be returned by 
    /// command help provider.
    /// 
    /// </summary>
    internal class SyntaxHelpInfo : BaseCommandHelpInfo
    {
        /// <summary>
        /// Constructor for SyntaxHelpInfo
        /// </summary>
        private SyntaxHelpInfo(string name, string text, HelpCategory category)
            : base(category)
        {
            _fullHelpObject = PSObject.AsPSObject(text);
            _name = name;
            _synopsis = text;
        }

        private string _name = "";
        /// <summary>
        /// Name for the help info
        /// </summary>
        /// <value>Name for the help info</value>
        override internal string Name
        {
            get { return _name; }
        }

        private string _synopsis = "";
        /// <summary>
        /// Synopsis for the help info
        /// </summary>
        /// <value>Synopsis for the help info</value>
        override internal string Synopsis
        {
            get { return _synopsis; }
        }

        private PSObject _fullHelpObject;

        /// <summary>
        /// Full help object for this help info
        /// </summary>
        /// <value>Full help object for this help info</value>
        override internal PSObject FullHelp
        {
            get { return _fullHelpObject; }
        }

        /// <summary>
        /// Get help info based on name, text and filename
        /// </summary>
        /// <param name="name">help topic name</param>
        /// <param name="text">help text</param>
        /// <param name="category">help category</param>
        /// <returns>SyntaxHelpInfo object created based on information provided</returns>
        internal static SyntaxHelpInfo GetHelpInfo(string name, string text, HelpCategory category)
        {
            if (String.IsNullOrEmpty(name))
                return null;

            SyntaxHelpInfo syntaxHelpInfo = new SyntaxHelpInfo(name, text, category);

            if (String.IsNullOrEmpty(syntaxHelpInfo.Name))
                return null;

            syntaxHelpInfo.AddCommonHelpProperties();

            return syntaxHelpInfo;
        }
    }
}