Logo Search packages:      
Sourcecode: ndoc version File versions  Download package

IntellisenseDocumenterConfig.cs

using System;
using System.IO;
using System.ComponentModel;
using System.Drawing.Design;
using System.Windows.Forms.Design;

using NDoc.Core;
using NDoc.Core.Reflection;

namespace NDoc.Documenter.Intellisense
{
      /// <summary>
      /// Config settings for the native Intellisense Documenter
      /// </summary>
      [DefaultProperty("OutputDirectory")]
00016       public class IntellisenseDocumenterConfig : BaseReflectionDocumenterConfig
      {
            /// <summary>
            /// Creates a new <see cref="IntellisenseDocumenterConfig"/> instance.
            /// </summary>
00021             public IntellisenseDocumenterConfig() : base("Intellisense")
            {
                  base.AutoDocumentConstructors = true;
                  base.DocumentAttributes = false;
                  base.DocumentInheritedMembers = DocumentedInheritedMembers.None;
                  base.DocumentInheritedFrameworkMembers = false;
                  base.UseNamespaceDocSummaries = false;
            }


            string _outputDirectory = string.Format(".{0}intellisense{0}", Path.DirectorySeparatorChar);
            
            /// <summary>Gets or sets the OutputDirectory property.</summary>
            /// <remarks>The folder where the root of the HTML set will be located.
            /// This can be absolute or relative from the .ndoc project file.</remarks>
            [Category("Documentation Main Settings")]
            [Description("The directory in which the XML files will be generated.\nThis can be absolute or relative from the .ndoc project file.")]
            [Editor(typeof(FolderNameEditor), typeof(UITypeEditor))]
            public string OutputDirectory
00040             {
                  get { return _outputDirectory; }

                  set
                  {
                        _outputDirectory = value;

                        if (!_outputDirectory.EndsWith(Path.DirectorySeparatorChar.ToString()))
                        {
                              _outputDirectory += Path.DirectorySeparatorChar;
                        }

                        SetDirty();
                  }
            }
            void ResetOutputDirectory() { _outputDirectory = string.Format(".{0}intellisense{0}", Path.DirectorySeparatorChar); }


            /// <summary>
            /// Gets or sets a value indicating whether to exclude 'NameSpaceDoc' classes.
            /// </summary>
            [Category("Visibility")]
            [Description("If true, classes named 'NamespaceDoc' will be excluded from the xml.\nDefault is false.")]
            [DefaultValue(false)]
            public bool ExcludeNameSpaceDocClasses
00065             {
                  get { return base.UseNamespaceDocSummaries; }
                  set { base.UseNamespaceDocSummaries = value; }
            }
            
            // HIDE BaseReflectionDocumenter that we do not need
            #region non - browsable properties
            /// <summary>
            /// 
            /// </summary>
            [Browsable(false)]
00076             public new bool UseNamespaceDocSummaries { get { return base.UseNamespaceDocSummaries; }  }
            /// <summary>
            /// 
            /// </summary>
            [Browsable(false)]
00081             public new AssemblyVersionInformationType AssemblyVersionInfo { get { return base.AssemblyVersionInfo; }  }
            /// <summary>
            /// 
            /// </summary>
            [Browsable(false)]
00086             public new bool AutoDocumentConstructors { get { return base.AutoDocumentConstructors; } }
            /// <summary>
            /// 
            /// </summary>
            [Browsable(false)]
00091             public new bool AutoPropertyBackerSummaries { get { return base.AutoPropertyBackerSummaries; } }
            /// <summary>
            /// 
            /// </summary>
            [Browsable(false)]
00096             public new string CopyrightHref { get { return base.CopyrightHref; } }
            /// <summary>
            /// 
            /// </summary>
            [Browsable(false)]
00101             public new string CopyrightText { get { return base.CopyrightText; } }
            /// <summary>
            /// 
            /// </summary>
            [Browsable(false)]
00106             public new string FeedbackEmailAddress { get { return base.FeedbackEmailAddress; } }
            /// <summary>
            /// 
            /// </summary>
            [Browsable(false)]
00111             public new bool DocumentAttributes { get { return base.DocumentAttributes; } }
            /// <summary>
            /// 
            /// </summary>
            [Browsable(false)]
00116             public new string DocumentedAttributes { get { return base.DocumentedAttributes; } }
            /// <summary>
            /// 
            /// </summary>
            [Browsable(false)]
00121             public new bool DocumentInheritedAttributes { get { return base.DocumentInheritedAttributes; } }
            /// <summary>
            /// 
            /// </summary>
            [Browsable(false)]
00126             public new bool ShowTypeIdInAttributes { get { return base.ShowTypeIdInAttributes; } }
            /// <summary>
            /// 
            /// </summary>
            [Browsable(false)]
00131             public new bool DocumentInheritedFrameworkMembers { get { return base.DocumentInheritedFrameworkMembers; } }
            /// <summary>
            /// 
            /// </summary>
            [Browsable(false)]
00136             public new DocumentedInheritedMembers DocumentInheritedMembers { get { return base.DocumentInheritedMembers; } }
            /// <summary>
            /// 
            /// </summary>
            [Browsable(false)]
00141             public new bool Preliminary { get { return base.Preliminary; } }
            /// <summary>
            /// 
            /// </summary>
            [Browsable(false)]
00146             public new bool IncludeDefaultThreadSafety { get { return base.IncludeDefaultThreadSafety; } }
            /// <summary>
            /// 
            /// </summary>
            [Browsable(false)]
00151             public new bool InstanceMembersDefaultToSafe { get { return base.InstanceMembersDefaultToSafe; } }
            /// <summary>
            /// 
            /// </summary>
            [Browsable(false)]
00156             public new bool StaticMembersDefaultToSafe { get { return base.StaticMembersDefaultToSafe; } }
            /// <summary>
            /// 
            /// </summary>
            [Browsable(false)]
00161             public new bool DocumentEmptyNamespaces { get { return false; } }
            /// <summary>
            /// 
            /// </summary>
            [Browsable(false)]
00166             public new bool ShowMissingParams { get { return base.ShowMissingParams; } }
            /// <summary>
            /// 
            /// </summary>
            [Browsable(false)]
00171             public new bool ShowMissingRemarks { get { return base.ShowMissingRemarks; } }
            /// <summary>
            /// 
            /// </summary>
            [Browsable(false)]
00176             public new bool ShowMissingReturns { get { return base.ShowMissingReturns; } }
            /// <summary>
            /// 
            /// </summary>
            [Browsable(false)]
00181             public new bool ShowMissingSummaries { get { return base.ShowMissingSummaries; } }
            /// <summary>
            /// 
            /// </summary>
            [Browsable(false)]
00186             public new bool ShowMissingValues { get { return base.ShowMissingValues; } }
            /// <summary>
            /// 
            /// </summary>
            [Browsable(false)]
00191             public new SdkLanguage SdkDocLanguage { get { return base.SdkDocLanguage; } }
            /// <summary>
            /// 
            /// </summary>
            [Browsable(false)]
00196             public new SdkVersion SdkDocVersion { get { return base.SdkDocVersion; } }
            /// <summary>
            /// 
            /// </summary>
            [Browsable(false)]
00201             public new bool CleanIntermediates { get { return base.CleanIntermediates; } }
            #endregion
      }
}

Generated by  Doxygen 1.6.0   Back to index