Template:Note/Doc: Difference between revisions
Jump to navigation
Jump to search
Carandraug (talk | contribs) m (make better sentence) |
Carandraug (talk | contribs) m (fixing text) |
||
| Line 2: | Line 2: | ||
Example:<br> | Example:<br> | ||
<nowiki>{{Note|methods of a class can be documented. The help for the constructor itself can be obtained with the constructor name, that is for the polynomial constructor | <nowiki>{{Note|methods of a class can be documented. The help for the constructor itself can be obtained with the constructor name, that is for the polynomial constructor {{Codeline|help polynomial}} will return the help string. Also the help can be obtained by restricting the search for the help to a particular class, for example {{Codeline|help @polynomial/polynomial}}. This second method is the only means of getting help for the overloaded methods and functions of the class.}}</nowiki> | ||
Will produce: | Will produce: | ||
{{Note|methods of a class can be documented. The help for the constructor itself can be obtained with the constructor name, that is for the polynomial constructor | <nowiki>{{Note|methods of a class can be documented. The help for the constructor itself can be obtained with the constructor name, that is for the polynomial constructor {{Codeline|help polynomial}} will return the help string. Also the help can be obtained by restricting the search for the help to a particular class, for example {{Codeline|help @polynomial/polynomial}}. This second method is the only means of getting help for the overloaded methods and functions of the class.}} | ||
<noinclude>[[Category:Template Documentation]]</noinclude> | <noinclude>[[Category:Template Documentation]]</noinclude> | ||
Revision as of 23:15, 11 December 2011
This template is for items which should be noted by the user, but are not important enough to be a Warning.
Example:
{{Note|methods of a class can be documented. The help for the constructor itself can be obtained with the constructor name, that is for the polynomial constructor {{Codeline|help polynomial}} will return the help string. Also the help can be obtained by restricting the search for the help to a particular class, for example {{Codeline|help @polynomial/polynomial}}. This second method is the only means of getting help for the overloaded methods and functions of the class.}}
Will produce:
<nowiki>
methods of a class can be documented. The help for the constructor itself can be obtained with the constructor name, that is for the polynomial constructor
help polynomial will return the help string. Also the help can be obtained by restricting the search for the help to a particular class, for example help @polynomial/polynomial. This second method is the only means of getting help for the overloaded methods and functions of the class.