Anonymous user
Documentation: Difference between revisions
Add Neko, or at least try to; the feature itself lacks documentation on the nekovm.org website.
Thundergnat (talk | contribs) m (→{{header|REBOL}}: Remove vanity tags) |
(Add Neko, or at least try to; the feature itself lacks documentation on the nekovm.org website.) |
||
Line 890:
%command in a comma-separated format. Such files start with a line</lang>
The comments will be revealed. However, a test with Octave elicited only the comment on the "function" line. If the file contained merely a sequence of commands (i.e. did not constitute the definition of a function) the first line of the above example would be absent and the file would start with a comment block.
=={{header|Neko}}==
'''nekoc -doc <file>''' generates XHTML documentation from within source. The compiler scans for <lang ActionScript>/** ... **/</lang> multi line comments.
Special <lang html><doc> ... </doc></lang> tags can be used inside these documentation blocks and are parsed as XML nodes; and checked for valid XHTML. Outside of the doc tags, the documentation parser can be used to create API documentation.
The feature does not care what file type is used for input, and most C sources for Neko libraries include documentation blocks of this type.
<lang C>/**
result_set_conv_date : 'result -> function:1 -> void
<doc>Set the function that will convert a Date or DateTime string
to the corresponding value.</doc>
**/</lang> produces '''void result_set_conv_date('result, function:1)''' for the API documentation, along with the prose. The syntax of the API style documentation is picky.
=={{header|Nim}}==
| |||