![]() Unnecessary unless you want to have a multi-paragraph description,īulleted list, or other more exotic structure. The third and subsequent paragraphs go into theĭetails: this is a (often long) section that comesĪfter the argument description and should provide any other importantĭetails of how the function operates. The second paragraph is the description: thisĬomes first in the documentation and should briefly describe what the Written in sentence case, and not end in a full stop. See when you look at help(package = mypackage) and is shownĪt the top of each help file. The first sentence is the title: that’s what you This introductory block is broken up as follows: For this to work properly, #' the arguments `.` should be unnamed, and dispatch is on the #' first argument. #' #' This is a generic function: methods can be defined for it directly #' or via the group generic. #' Sum of vector elements #' #' `sum` returns the sum of all the values present in its arguments. The source doc will be able to read the docs. This is useful if you want to use roxygen2Ĭonventions for documenting an internal function only people reading If you want to use roxygen2 documentation tags without generating an Blocks ignore empty lines, including lines made up of transferfull Command ignored, but anything here is still included. For example, you could use feature ('doxygen:ignore:transferfull') Fantastic () / A fantastic function. Text within the description or tags can be formatted usingĪ block ends when it hits R code, usually a function or objectĪssignment. This feature makes it possible to just ignore an unknown Doxygen command, instead of replacing it with the predefined text that doxygen:alias does. Their content extends to the start of the next tag or the end of theīlock. Tags start with like Tags must appear at the beginning of a line and The introduction continues until the first Introduction and forms the title, description, andĭetails, as described below. The first lines of the block is called the ![]() Whatever the program writes to standard output is used as the file. FILEVERSIONFILTER tag, and input-file is the name of an input file provided. popen ()) the command command input-file, where command is the value of the. (So the name of tag is 'FONT' and name of is 'TABLE').The name is always in uppercase and it doesnt contain ' or / characters. If youre familiar with Javadoc or the Visual Studio XML documenting mechanism, youll easily master Doxygen. Doxygen will invoke the program by executing (via. Deprecated: Todo: provide deprecation description wxString wxHtmlTag::GetName ( ) const Returns tags name. It can be used from its graphical wizard, from the command line or as part of a make process. A roxygen block is a sequence of lines starting with Doxygen is a mature tool, equivalent to Javadoc.
0 Comments
Leave a Reply. |