The return value is a SgAsmBlock node that contains all | 4| * successful, then an abstract syntax tree is returned. | 3| * This method does everything from parsing the command-line to generating an abstract syntax tree.
| 1| /** Most basic use of the partitioner. You can easily insert HTTP links into documentation.Use and to give the same documentation to both member functions.Use when referring to another class and when mentioning a parameter.First line (up to punctuation) is a summary – the autobrief string that shows up in tables of contents.Use C-style block comments for documentation.Here's an example that documents a couple of closely-related class member functions.
An example is this page itself, which might change over time as ROSE evolves and which must go through ROSE's continuous integration testing and/or release testing.
Each item is also presented along with our motivation for doing it this way. The style enumerated here does not necessarily need to be used for projects, tests, the tutorial, user-code, etc. It specifies how we would like to have the ROSE library source code documented. This chapter is mainly for developers working on the ROSE library as opposed to users developing software that uses the library.
DOXYGEN AUTHOR HOW TO
How to write good API and non-API documentation in ROSE.
0 kommentar(er)
