QCAD

QCAD - 2D CAD System.

Click here for a documentation of the DokuWiki formatting syntax that can be used in reports

Please search for existing tasks (also closed ones) before opening a new task.

Please make sure that you are using the latest Version of QCAD before posting a bug (menu Help - Check for Updates)

Tasklist

FS#80 - API Doc Organization

Attached to Project: QCAD
Opened by Andrew (andrew) - Thursday, 12 May 2011, 17:35 GMT+1
Last edited by Martin (martin) - Wednesday, 18 May 2011, 13:34 GMT+1
Task Type Task
Category Documentation
Status Closed
Assigned To Andrew (andrew)
Martin (martin)
Operating System All
Severity Low
Priority Normal
Reported Version Development
Due in Version Undecided
Due Date Undecided
Percent Complete 100%
Votes 0
Private No

Details

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
This task depends upon

Closed by  Martin (martin)
Wednesday, 18 May 2011, 13:34 GMT+1
Reason for closing:  Implemented
Comment by Martin (martin) - Friday, 13 May 2011, 16:33 GMT+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.

Loading...