Documentation*

What is this aspect used for?

This aspect is part of com.mbeddr.doc. It allows to define Documentation nodes that can be exported to xhtml, latex and markdown at the moment. New targets can be implemented easily. When you invoke the intention "Add Reference to Documented Concept" when defining a new section as part of a chapter, the documention for this concept will be shown in the Documentation tool at the bottom part of the screen.

How do I export the documentation?

Click make or rebuild model that contains the documentation, a new folder /doc_gen is generated.

Should I write documentation? Do I need to use this aspect.

Yes, code is not always self documenting. You have the following possibilities for writing documention:

  1. Use javadoc liberally ↩

Last update: November 10, 2021

Comments

Back to top