- Status Closed
- Percent Complete
- Task Type Task
- Category Documentation
-
Assigned To
Andrew - Operating System All
- Severity Low
- Priority Very Low
- Reported Version Development
- Due in Version Undecided
-
Due Date
Undecided
- Votes
- Private
Attached to Project: QCAD Bugtracker
Opened by Andrew - 12.05.2011
Last edited by Anonymous Submitter - 18.05.2011
Opened by Andrew - 12.05.2011
Last edited by Anonymous Submitter - 18.05.2011
FS#80 - API Doc Organization
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
Closed by Anonymous Submitter
18.05.2011 11:34
Reason for closing: Implemented
18.05.2011 11:34
Reason for closing: Implemented
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.