Documentation

What is this branch about

• Documentation of PELICAN and PPE

What did I do

• Shortend namespace names:
  • Renamed namespace PropagationParameterEngine to PPE
  • Renamed namespace PropagationModules to PropModules
  • Renamed namespace PropagationParameters to PropParams
• Added using typedefs to reduce clutter and improve doxygen readability
• Added PropModules readme. How to create and use a module. How does factory work
• Added Factory readme.
• Added Functionality readme. Dont know about the name but it tries to explain the components of PELICAN and what they do.

Missing

• The webidl.md is TODO. There should be some readme explaining how the config files works and how to add new module configs to the webidl. However, this depends on the final polyscribe function. I also currently don't know how some types like strings work in the webidl. Add (at least a rough) docu later once polyscribe works. Maybe also link from the PropModules readme as one has to create a new module config in the webidl.

added documentation label

requested review from @cmo and @pascal.palenda

assigned to @niklas

changed the description

added 1 commit

• 99b6a701 - - moved documentation into own directory

Compare with previous version

added 1 commit

• ed5c1f77 - moved pelican into own apps folder

Compare with previous version

added 1 commit

• 34f42aa9 - added cmakelist to include pelican folder

Compare with previous version

added 1 commit

• dc39e0ea - - updated top level readme to link to PELICAN

Compare with previous version

added 2 commits

• 29cad235 - updated paths after moving docu to own folder
• bf6ebf3d - added link to pelican branch

Compare with previous version

added 6 commits

• 63a88775 - Extended docu
• eb6afe0d - clang format
• a02db94d - added another typedef
• fda541e8 - small todo note
• ac90fd73 - documentation of factory
• b54dc637 - Added docu file that will describe the overall structure and is maybe the landing page for pelican

Compare with previous version

added 2 commits

• 19d96833 - Added small Documentation for the overall functionality of PELICAN.
• 628612bb - Added some idea what to write here later. Depends on the actual final implementation of polyscribe

Compare with previous version

marked this merge request as ready

changed the description

@pascal.palenda @cmo I now slowly have more time to add a few things to the documentation. I tried to add an overview in the “Functional.md”. Please review what to see what important bits are missing. Then I can add it. Or mark where I should add one or two sentences.

As it says in the (new) description above, the webidl.md docu is still TODO. But I think we should only write it when issue #10 and #15 are fixed.

At least the PropModule creation readme should be detailed enough for one to create a new module (minus the propConfig in the webidl).

mentioned in issue #11 (closed)

I updated the mermaid diagram. See !2. We should maybe include it in the docu as .svg or .png?

The documentation for propagation modules seems to be using the wrong namespaces in the example for the header file: 'ITAPropagationModels::PPE::PropModules' should be 'ITAPropagationModels::PropagationParameterEngine::PropagationModules'

https://git.rwth-aachen.de/ita/ITAPropagationModels/-/blob/feature/documentation/doc/PropagationModules.md#create-new-module

resolved all threads

assigned to @pascal.palenda and unassigned @niklas

added 2 commits

• 77bdfd00 - Refactor: move `build_doc` to main CMakeLists
• 7508a3f9 - Docs: add namespace doc

Compare with previous version