|
|
(4 intermediate revisions by 2 users not shown) |
Line 1: |
Line 1: |
| This template is for items which should be noted by the user, but are not important enough to be a [[Template:Warning|Warning]]. | | This template is for items which should be noted by the user, but are not important enough to be a [[Template:Warning|Warning]]. |
|
| |
|
| Example:<br> | | Example: |
| <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 @code{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> | | :<nowiki>{{Note|Methods of a class can be documented but the only way to access their help text is by specifying the class as in {{Codeline|help @class/method}}.}}</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 @code{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.}} | | :{{Note|Methods of a class can be documented but the only way to access their help text is by specifying the class as in {{Codeline|help @class/method}}.}} |
| <noinclude>[[Category:Template Documentation]]</noinclude>
| | |
| | [[Category:Template with documentation]] |