[kepler-dev] Kepler Javadocs Request

[Nandita Mangal]

Hi All,
I also request kepler developers to check and add the required developer 
documentation in their actor source files for javadocs.
Also kindly follow the tags and doclets as specified. If you feel the 
need to add a new tag to the Documenation Pages , please contact
me.
As far I can remember, Samantha and Laura are incharge of filling in the 
UserLevelDocumenation Tags in the source files.Correct me if i am wrong.
thanks,
nandita.

>
> As discussed in Kepler meeting , we are creating kepler documentation 
> based on Ptolemy's documentaionFramework :
>
>1)A doc/doclets/PtDoclet.java reads Actor java files and generates xml using the DTD at
>ptolemy/vergil/basic/DocML_1.dtd.  These .xml files are in kepler-docs/dev/documentationFramework/generatedJavadocs.
>
>Both kepler as well as ptolemy javadocs are generated and the resultant XML files are in the generatedJavadocs folder.
>
>The javadocs are named with extension "*.doc.xml" to avoid mixup with Kepler src/actors XMLs.
>
>
>
>
>2) The Javadocs Doclet contains the basic info fields and tags, and also contain a "UserLevelDocumentation" tag, to 
>allow Kepler to create separate "UserDocumenation" pages as well for the same actor.
>
>
>  
>
> _DeveloperDocumenation_
> Description
>  Author
>  Version
>  Ports Summary (Port Name + description)
>  Parameters Summary (Parameter Name + description)
> Sample Demos (To be added)
>
> _User Documentation Fields_
>  UserLevelDescription
>  Author
>  Version
>  Ports Summary (Port Name + UserLevelDescription)
>  Parameters Summary (Parameter Name + UserLevelDescription)
> Sample Demos (To be added)
>
> A sample javadoc XML file and its two user/developer HTML files 
> created are attached.
> The final documentation pages are in 
> kepler-docs/dev/documenationFramework/generatedHTMLPages/user (or 
> developer)
> The main page with the ontology tree links to actors is 
> "FinalUserDocumentation.html (or FinalDeveloperDocumentation.html) in 
> generatedHTMLPages folder.
>
>
> 3)In progress: Fully integrate the "customizeDocumentation" feature as 
> implemented by Ptolemy on canvas.
>
> Any comments/errors please let me know.
>
> Thanks,
> nandita.
>
>