Creating a CodeDOM: Modeling the Semantics of Code (Part 2)

// The Nova Project by Ken Beckett.
// Copyright (C) 2007-2012 Inevitable Software, all rights reserved.
// Released under the Common Development and Distribution License, CDDL-1.0: http://opensource.org/licenses/cddl1.php

namespace Nova.CodeDOM
{
    /// <summary>
    /// Documents a method or indexer parameter.
    /// </summary>
    public class DocParam : DocNameBase
    {
        #region /* CONSTRUCTORS */

        /// <summary>
        /// Create a <see cref="DocPara"/>.
        /// </summary>
        public DocParam(ParameterRef parameterRef, string text)
            : base(parameterRef, text)
        { }

        /// <summary>
        /// Create a <see cref="DocPara"/>.
        /// </summary>
        public DocParam(ParameterRef parameterRef, params DocComment[] docComments)
            : base(parameterRef, docComments)
        { }

        /// <summary>
        /// Create a <see cref="DocPara"/>.
        /// </summary>
        public DocParam(ParameterDecl parameterDecl, string text)
            : base(parameterDecl.CreateRef(), text)
        { }

        /// <summary>
        /// Create a <see cref="DocPara"/>.
        /// </summary>
        public DocParam(ParameterDecl parameterDecl, params DocComment[] docComments)
            : base(parameterDecl.CreateRef(), docComments)
        { }

        #endregion

        #region /* PROPERTIES */

        /// <summary>
        /// The XML tag name for the documentation comment.
        /// </summary>
        public override string TagName
        {
            get { return "param"; }
        }

        #endregion
    }
}