FS#80API Doc Organization
- Type
- Task
- Status
- Closed
- Resolution
- Implemented
- Category
- Documentation
- Severity
- Low
- Priority
- Low
- Reported version
- Development
- Operating system
- All
- Reported
- 2011-05-12 by andrew
- Closed
- 2011-05-18 by deleted user
Rename everything from "RSFramework" to "QCAD Application Framework" (qcad_application_framework.pro / dox / doxyfile ...).
Add header with copyright / link to homepage.
Structure of documentation:
- Entry (main) page
- API (links to API doc for modules):
- math
- core
- gui
- ...
- ECMAScript Developers (links to intros and examples):
- ECMAScript introduction
- ECMAScript module
- API (links to API doc for modules):
Comments (1)
It's a bit confusing that Doxygen automatically links all know classes, e.g. the word "Rename" is a class, too.
From "Getting Started with QCAD ECMAScript":
Rename the files inside the directory to "Point3P.js", "Point3P.pro" and "Point3P.svg".
"Rename" is linked to the class "Rename" located in Block.