Ticket #23 (closed defect: fixed)

Opened 3 years ago

Last modified 2 years ago

documentation

Reported by: helder.magalhaes@gmail.com Assigned to: Jan-Klaas Kollhof
Priority: lowest Milestone: 2.0
Component: jsolait-core Version: 2.0
Severity: normal Keywords: fuzwlaib zvigqol
Cc: fuzwlaib zvigqol

Description

Although the automatic documentation generation issue isn't resolved yet (Ticket #22), I decided to make some experiments by manually replacing the XML's special characters for their correspondent entities.

I quickly found out that documentation generation did not consider third party library directories. :-|

My sugestion was that, by default, a separate XML documentation file was generated for each of the libraries ('lib', 'lib3rdParty1', 'lib3rdParty2', etc). Nevertheless, the ideal was that it could be configured somewhere (changing between a single/multiple documentation files). :-)

Funcional automatic documentation generation would be a great feature to have correctly supported, as the power of XML schemas (XSD) could easily (?) turn the currently generated format into a nice looking document. This is also valid for jsolait's documentation, for which an automatic 'wikifier' could be build afterwards. ;-)

Hope to see the feature available soon so that documentation experiments can be made! :-)

Best regards,

Helder

Change History

03/27/06 08:56:17 changed by helder.magalhaes@gmail.com

  • type changed from defect to enhancement.

In fact, this is an enhancement to jsolait other than a defect. It's not a broken feature, but else something that would be very useful (in my opinion) for all jsolait users.

I apologize for the initial mistake,

Helder

05/28/06 12:36:45 changed by helder.magalhaes@gmail.com

  • status changed from new to closed.
  • resolution set to fixed.

Experiments made with the new package organization showed that external documentation generation now works. External code, placed in "packages" directory, is now parsed during builds, and embed documentation generated along with jsolait's.

Thank you! :-)

(Note: yet, some manual editing must be done to the generated document due to the issue identified in Ticket #22)

06/28/06 11:11:56 changed by Jan-Klaas Kollhof

  • summary changed from fuzwlaib zvigqol to documentation.