Ticket #22 (closed defect: fixed)

Opened 3 years ago

Last modified 2 years ago

documentation

Reported by: Helder Magalhães Assigned to: Jan-Klaas Kollhof
Priority: highest Milestone: 2.0
Component: jsolait-core Version: 2.0
Severity: blocker Keywords: nofhkmczr ovmkfc
Cc:

Description

After building jsolait from scratch, when opening the generated documentation I discovered it was not well formed. The problem was caused by an unescaped & (ampersand) character (which a XML's special character). :-|

My sugestion was to handle those character while parsing, taking the oportunity to handle all of the XML's special character set: 

&	&	(ampersand)
'	'	(apostrophe)
"	"	(quotation mark)
<	&lt;	(less than sign)
>	&gt;	(greater than sign)

Hope I didn't miss any of them! :-)

Best regards,

Helder

Change History

03/22/06 11:07:28 changed by Jan-Klaas Kollhof

  • status changed from new to assigned.

03/24/06 12:41:14 changed by helder.magalhaes@gmail.com

  • milestone set to 2.0.

While doing some more experiments on the documentation generation features of jsolait, I questioned myself it this problem was related with the documentation's description field only or was an issue on the lang module.

If it was related to the description field only, I'd propose some extra effort in implementing (some) javadoc features, parsing the @param, @return and such into XML notes so that an XML Schema (proposal at Ticket #23) can be made more powerful.

This is somehow a feature request to be futurely submited, but if it could easily be considered in this ticket's scope... :-)

Best regards,

Helder

06/28/06 11:12:55 changed by Jan-Klaas Kollhof

  • summary changed from nofhkmczr ovmkfc to documentation.

07/14/06 09:50:51 changed by Jan-Klaas Kollhof

  • status changed from assigned to closed.
  • cc deleted.
  • version set to 2.0.
  • resolution set to fixed.
  • milestone set to 2.0.