Generating Customizable API Documentation for Word, LaTeX and HTML

OData support
Supervisor:
Dr. Simon Balázs
Department of Control Engineering and Information Technology

Increasingly complex applications result in increasingly longer codes. Consequently, there is growing demand for API documentation belonging to the programmes that can facilitate software maintenance and development as well.

Therefore, the major platforms support the automatic generation of API documentation. Moreover, in some cases e.g. .NET, they even contain the necessary integrated tools. In addition, it is possible to use general documentation generator programmes (Doxygen, Twintext) that support more than one platform.

They are certainly useful, but in some cases it can be necessary to define the logical structure of the output as well. Sometimes, it is not the built-in style that is required. Moreover, it may be necessary to copy the API documentation received as an output into a finished document. The current documentation generator programmes do not or only partially meet the requirements above.

The purpose of the thesis is to plan and develop a documentation generator programme that can solve these problems. The logical structure of the output can be set and the programme should support the frequent output formats (LaTeX, HTML, Word) and the use of the external styles. In addition, it should be suitable for a partially finished other documentation, especially in the case of Word.

Downloads

Please sign in to download the files of this thesis.