File: CodeCommentStatement.xml

package info (click to toggle)
monodoc 1.1.18-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 58,432 kB
  • ctags: 4,991
  • sloc: xml: 718,392; cs: 38,337; sh: 3,172; perl: 554; makefile: 303
file content (156 lines) | stat: -rwxr-xr-x 6,699 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
<Type Name="CodeCommentStatement" FullName="System.CodeDom.CodeCommentStatement">
  <TypeSignature Language="C#" Value="public class CodeCommentStatement : System.CodeDom.CodeStatement" Maintainer="auto" />
  <AssemblyInfo>
    <AssemblyName>System</AssemblyName>
    <AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
    <AssemblyVersion>1.0.3300.0</AssemblyVersion>
    <AssemblyCulture>neutral</AssemblyCulture>
    <Attributes>
      <Attribute>
        <AttributeName>System.Resources.NeutralResourcesLanguageAttribute</AttributeName>
      </Attribute>
      <Attribute>
        <AttributeName>System.Resources.SatelliteContractVersionAttribute</AttributeName>
      </Attribute>
      <Attribute>
        <AttributeName>System.CLSCompliantAttribute</AttributeName>
      </Attribute>
      <Attribute>
        <AttributeName>System.Runtime.InteropServices.ComVisibleAttribute</AttributeName>
      </Attribute>
      <Attribute>
        <AttributeName>System.Security.AllowPartiallyTrustedCallersAttribute</AttributeName>
      </Attribute>
    </Attributes>
  </AssemblyInfo>
  <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
  <Docs>
    <summary>
      <see cref="T:System.CodeDom.CodeStatement" /> representing a comment in the code graph.</summary>
    <remarks>To be added</remarks>
  </Docs>
  <Base>
    <BaseTypeName>System.CodeDom.CodeStatement</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes>
    <Attribute>
      <AttributeName>System.Runtime.InteropServices.ComVisibleAttribute</AttributeName>
    </Attribute>
    <Attribute>
      <AttributeName>System.Runtime.InteropServices.ClassInterfaceAttribute</AttributeName>
    </Attribute>
  </Attributes>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public CodeCommentStatement ();" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters />
      <Docs>
        <summary>Creates a <see cref="T:System.CodeDom.CodeCommentStatement" /> with an empty comment text. The <see cref="P:System.CodeDom.CodeCommentStatement.Comment" /> property should be used before emitting the code for the object.</summary>
        <returns>To be added: an object of type 'CodeCommentStatement'</returns>
        <remarks>
          <example>
Creating the code for the following statement throws an Exception because the value of the CodeCommentStatement Comment property hasn't been set.
  <code lang="C#">
...
demoNs.Comments.Add(new CodeCommentStatement());
...
  </code></example>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public CodeCommentStatement (CodeComment comment);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="comment" Type="System.CodeDom.CodeComment" />
      </Parameters>
      <Docs>
        <summary>Creates a <see cref="T:System.CodeDom.CodeCommentStatement" /> initalized with the comment in the specified <see cref="T:System.CodeDom.CodeComment" /> object.</summary>
        <param name="comment">CodeComment this CodeCommentStatement is to be initialized with.</param>
        <returns>To be added: an object of type 'CodeCommentStatement'</returns>
        <remarks>To be added
<example>
            <code lang="C#">
...
		CodeComment com=new CodeComment("foo!");
		com.DocComment=true;
		demoNs.Comments.Add(new CodeCommentStatement(com));
...
  </code>
emits
  <code lang="C#">
/// foo!
  </code></example></remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public CodeCommentStatement (string text);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="text" Type="System.String" />
      </Parameters>
      <Docs>
        <summary>Creates a <see cref="T:System.CodeDom.CodeCommentStatement" /> with the <see cref="P:System.CodeDom.CodeCommentStatement.Comment" /> property initialized to the specified string.</summary>
        <param name="text">String the Comment property of this object is to be initialized to.</param>
        <returns>To be added: an object of type 'CodeCommentStatement'</returns>
        <remarks>
          <example>
            <code lang="C#">
		demoNs.Comments.Add(new CodeCommentStatement("This is a test"));
  </code>
generates the code
  <code lang="C#">
// This is a test
  </code></example>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public CodeCommentStatement (string text, bool docComment);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="text" Type="System.String" />
        <Parameter Name="docComment" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <summary>Creates a <see cref="T:System.CodeDom.CodeCommentStatement" /> with the <see cref="P:System.CodeDom.CodeCommentStatement.Comment" /> property initialized to the specified string. The docComment argument signifies whether the comment is a regular comment or a document line.</summary>
        <param name="text">String the Comment property of this object is to be initialized to.</param>
        <param name="docComment">If true, specifies a documentation comment; otherwise a regular comment is produced.</param>
        <returns>To be added: an object of type 'CodeCommentStatement'</returns>
        <remarks>
          <example>
            <code lang="C#">
demoNs.Comments.Add(new CodeCommentStatement("This is a docstring test",true));
demoNs.Comments.Add(new CodeCommentStatement("This is a test",false));
  </code>
generates the following code for C#
  <code lang="C#">
/// This is a docstring test
// This is a test
  </code></example>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Comment">
      <MemberSignature Language="C#" Value="public CodeComment Comment { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.CodeDom.CodeComment</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>This is the text of the comment to be generated.</summary>
        <param name="value">String contents of the comment.</param>
        <returns>To be added: an object of type 'CodeComment'</returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
  </Members>
</Type>