Like JavaDoc, embedded documentation is enclosed in specially structured doc comments . The text after the tag continues until a new tag is reached or the end of comment is found. The available tags are based on the set defined in JavaDoc. Gives the function name. Followed by any number of lines of free text with markup.
Type is as defined in the function.
Can be used more than once if appropriate. Can be used more than once if appropriate. Effectively ends the doc comment. Any following text is ignored by the HTML conversion parser. Code Mnemonic Description r Read Value is used but not changed w Write Value is ignored.