Presentations can range from an overview of the entire BRL-CAD package to an in-depth review of a specific feature or technical algorithm. It offers both command line and menu driven. Currently, the only specification in the BRL-CAD documentation set is a draft specification of the. the Multi-Device Geometry Editor, is the central interaction environment for the BRL-CAD package. Specifications are formal documents that define formats or protocols that others can independently implement. In some cases, books can be collections of lessons, reports, articles, and/or other forms of documentation that are compiled between one set of covers. They are generally less comprehensive in scope and/or detail than a full-blown book.īooks are typically large documents that cover many aspects of BRL-CAD. Unlike lessons, reports and articles are primarily designed to inform rather than train. These can be technical reports, journal articles, conference papers, and/or similar focused descriptions of specific aspects of the package.
Unlike other documents, lessons focus on step-by-step teaching.
Lessons are documents that are used to train a user to master a particular aspect of BRL-CAD. However, it does not address user-level programs or commands.
#BRL CAD COMMANDS CODE#
Specially formatted source code comments in the headers are converted to HTML documentation by Doxygen (), a tool for generating source code documentation.ĪPI documentation is the lowest level, most authoritative documentation of BRL-CAD's programming interfaces. API documentation, on the other hand, is automatically generated from the headers in the application's source code. The following MGED editing session contains all the commands needed. Most of the project's documentation is maintained in the BRL-CAD source code repository as DocBook files (see the chapter Working with Our Documentation for more information about DocBook). Lets look at the commands needed to build the cup geometry described in the first section. Man pages may reference other man pages, but they are intended to be the primary source of documentation for a specific tool and should be written with a very tight focus. Man pages are command-specific or program-specific documentation which thoroughly document and demonstrate the use of that command or program. The wiki is not currently integrated with any of the other documentation systems in BRL-CAD, although this remains one of BRL-CAD's project goals. The easiest way to contribute as a documenter is through BRL-CAD's wiki (a website that users can edit) at. This chapter briefly introduces the types of documentation that the BRL-CAD project maintains, as well as the purpose of each document. If you think a command is related to another, then please add a "See Other" reference!Ĭommand not working (Possible deprecation).BRL-CAD provides developers, users, and others with a range of documentation covering the basics of the software, its usage, and development APIs. This section is a logical cross reference designed to aid a user in finding related commands quickly. The current area that needs the most work is the "See Other" section of all the pages. Maintenance is accomplished via the user community, so do not be afraid to fix a mistake you encounter! If you are unable to or are unsure, then please email a link to the page in question and your write up to Dave Loman.
0 kommentar(er)
