Skip to content

Latest commit

 

History

History
12 lines (10 loc) · 715 Bytes

cobigen-documentation.asciidoc

File metadata and controls

12 lines (10 loc) · 715 Bytes
Table of Contents

Wiki documentation — conventions & hints

Conventions

  • Stick to the devonfw-docgen conventions to make the generation of the PDF document from the wiki work properly.

  • The source code of CobiGen should be documented completely and consistent using JavaDoc. Please check JavaDoc as well after changing any logic.

  • Further documentation of more abstract and informative issues for users, template developers and CobiGen developers should be done using the GitHub Wiki

  • All GitHub Wiki pages should be edited in AsciiDoc mode to ensure the PDF documentation generation possibility