Important Notice: Our web hosting provider recently started charging us for additional visits, which was unexpected. In response, we're seeking donations. Depending on the situation, we may explore different monetization options for our Community and Expert Contributors. It's crucial to provide more returns for their expertise and offer more Expert Validated Answers or AI Validated Answers. Learn more about our hosting issue here.

How is the documentation of the API done?

API documentation
0
10 Posted

How is the documentation of the API done?

0

A reference like documentation consists within the IDL files. The syntax of the documentation is based on JavaDoc with a few extensions to mark identifiers. We are currently developing a new generator for this syntax which will generate HTML documents directly from the IDLs. Our Developers Guide describes the concepts of all components within OpenOffice.org which have an API. It is the best resource to start learning about the API. Additionally we have a tutorial for StarBASIC programmers. It explains the basic concepts, shows some UML diagrams of the component structure and has plenty of documented examples of the API usage.

Related Questions

What is your question?

*Sadly, we had to bring back ads too. Hopefully more targeted.