[ROOT] / doc / toc / ARCDoc

Class , Enum

A library supporting documentation and demonstrating usage of AgoRapide.

Offers the following functionality:

1) Transforming IP instances into HTML.
Important method is ARCDoc.Extensions.ToHTMLSimpleSingle
Can also transform recursively (transform hierarchical structures) and store those structures to disk as static HTML files with LinkInsertionInDocumentation.
Important class in this regard is HLocationCollection.

2) Generation of documentation by extracting BaseAttribute tags (like this one) for the different parts of your application. Compiling everything together in a coherent HTML presentation with links between the different topics.
Important classes are
DocFrag (Documentation fragment),
HTOC (Hierarchical table of contents).

The documentation can also be viewed with the help of ARCQuery, just like any other PropertyStream based data.

3) Demonstration of practical use of AgoRapide, through small easy to follow examples, like:
a) 'Normal' AgoRapide classes and their usage.
b) Demonstrate BoilerplateCodeProperties.
c) Demonstrate BoilerplateCodePropertiesAndStorage.

TODO: Extract the actual code examples from ARCDoc into this documentation text.

Note that you are not required to generate documentation / use this library (ARCDoc), your application works quite fine based on only ARCCore.

Note that the AgoRapide library ARCQuery offers much richer functionality for generating HTML views (and also JSON views). Especially because it offers search and filtering functionality).

Generated 2024-04-18 21:26:41.124 UTC