Hi Ron:
I do sets that include both javadoc and API guides in FM/PDF all the time.
The way I think of it is that the javadoc is a complete reference to
the public API, kind of like a dictionary of all the classes and
methods. The FM documentation is more like an encyclopedia. I
usually call
/how_to_write_api_documentation
Hope this helps,
Sean Pollock
Siemens PLM Software
> To: framers at lists.frameusers.com> From: ronsmiller at comcast.net>
> Subject: API documentation with references to Javadocs documentation> Date:
> Tue, 13 May 2008 10:46:53 -0400> > Hi:> I ha
Hi Ron:
I do sets that include both javadoc and API guides in FM/PDF all the time.
The way I think of it is that the javadoc is a complete reference to
the public API, kind of like a dictionary of all the classes and
methods. The FM documentation is more like an encyclopedia. I
usually call
Hi:
I have a JavaDocs reference. My client has asked me to write an API
document in Frame with references to the JavaDocs documentation. The
goal of the document is to provide further explanation and examples
along with a context for usage beyond what is provided in the
JavaDocs. In
/how_to_write_api_documentation
Hope this helps,
Sean Pollock
Siemens PLM Software
To: framers@lists.frameusers.com From: [EMAIL PROTECTED] Subject: API
documentation with references to Javadocs documentation Date: Tue, 13 May
2008 10:46:53 -0400 Hi: I have a JavaDocs reference. My client has asked
Hi:
I have a JavaDocs reference. My client has asked me to write an API
document in Frame with references to the JavaDocs documentation. The
goal of the document is to provide further explanation and examples
along with a context for usage beyond what is provided in the
JavaDocs. In
