Skip to content

Latest commit

 

History

History
47 lines (33 loc) · 965 Bytes

README.md

File metadata and controls

47 lines (33 loc) · 965 Bytes

Using comments

When invoked with empty decorations (--decorations "") OrthoDocs consider every comment in well-known positions as annotation bound to the syntactic part of interest.

In the following example:

  • the multiline comment preceeding the function definition is bound to the function detailed description
  • comments immediately preceeding parameters are bound to the corresponding parameter's detailed description
  • every other comment is ignored.
/*
 * This global public function
 * will be documented.
 */
function example_func(
  // This is the first parameter
  parm1=1,
  // This is the second parameter
  parm2=0
) =
  // this comment is ignored
  true;

The produced documentation is the following:

function example_func

Syntax:

example_func(parm1=1,parm2=0)

This global public function will be documented.

Parameters:

parm1 This is the first parameter

parm2 This is the second parameter