template.markdown.substitution.substitution-reporting.README.md Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of credible-doc-generator Show documentation

This module generates documentation for the https://github.com/credibledoc/credible-doc repository projects. See description on the https://github.com/credibledoc/credible-doc page.

There is a newer version: 1.0.51

Show newest version

Notice: work in progress.

# Module `substitution-reporting`
This module is a java library. This library helps to generate reports.
Reports are parts of some application documentation.

## Usage
This module is the source for the `&&beginPlaceholder {
                                          "className": "com.credibledoc.substitution.content.generator.pom.JarNameContentGenerator",
                                          "description": "Latest name and version of substitution-reporting artifact in Maven Central Repository",
                                          "parameters": {
                                              "url": "https://repo1.maven.org/maven2/com/credibledoc/substitution-reporting/maven-metadata.xml",
                                              "nameAndVersionSeparator": "-"
                                          }
                                   } &&endPlaceholder` library.

This library can be loaded from the [Maven Central Repository](https://mvnrepository.com/artifact/com.credibledoc/substitution-reporting).

Example of Maven configuration in a `pom.xml` file

    
    
    
        ... some mandatory tags omitted
    
        
            
                com.credibledoc
                substitution-reporting
                &&beginPlaceholder {
                        "className": "com.credibledoc.substitution.content.generator.pom.JarNameContentGenerator",
                        "description": "Latest version of substitution-reporting artifact in Maven Central Repository",
                        "parameters": {
                            "url": "https://repo1.maven.org/maven2/com/credibledoc/substitution-reporting/maven-metadata.xml",
                            "versionOnly": "true"
                        }
                 } &&endPlaceholder
            
        
    
    

## How the generated reports look like
Example: [diagrams.md](../../credible-doc-generator/doc/diagrams.md)

Parts of documentation for this repository [credible-doc](../README.md),
for example [diagrams.md](../../credible-doc-generator/doc/diagrams.md), are generated with help of this `substitution-reporting` module.

## Dependencies of the `substitution-reporting` module on other `credible-doc` repository classes
&&beginPlaceholder {
    "className": "com.credibledoc.substitution.content.generator.dependency.PackageDependenciesContentGenerator",
    "description": "UML diagram with dependencies of the `substitution-reporting` module on classes from other modules of the `credible-doc` repository.",
    "parameters": {
        "sourceRelativePathsPipeSeparated": "substitution/substitution-reporting/src/main/java",
        "dependantPackage": "com.credibledoc.substitution.reporting",
        "dependenciesPackagesPipeSeparated": "com.credibledoc",
        "ignoreInnerPackages": "true"}
} &&endPlaceholder