Living Documentation annotations

Annotations to help to generate a nice living documentation

License	Apache License, Version 2.0
GroupId	ch.ifocusit.livingdoc
ArtifactId	livingdoc-annotations
Last Version	1.10
Release Date	May 18, 2018
Type	jar
Description	Living Documentation annotations Annotations to help to generate a nice living documentation
Project URL	https://github.com/jboz/living-documentation
Project Organization	Focus IT
Source Code Management	https://github.com/jboz/living-documentation

Download livingdoc-annotations

Filename	Size
livingdoc-annotations-1.10.pom
livingdoc-annotations-1.10.jar	9 KB
livingdoc-annotations-1.10-sources.jar	10 KB
livingdoc-annotations-1.10-javadoc.jar	33 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/ch.ifocusit.livingdoc/livingdoc-annotations/ -->
<dependency>
    <groupId>ch.ifocusit.livingdoc</groupId>
    <artifactId>livingdoc-annotations</artifactId>
    <version>1.10</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/ch.ifocusit.livingdoc/livingdoc-annotations/
implementation 'ch.ifocusit.livingdoc:livingdoc-annotations:1.10'

Gradle Kotlin

// https://jarcasting.com/artifacts/ch.ifocusit.livingdoc/livingdoc-annotations/
implementation ("ch.ifocusit.livingdoc:livingdoc-annotations:1.10")

Apache Buildr

'ch.ifocusit.livingdoc:livingdoc-annotations:jar:1.10'

Apache Ivy

<dependency org="ch.ifocusit.livingdoc" name="livingdoc-annotations" rev="1.10">
  <artifact name="livingdoc-annotations" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='ch.ifocusit.livingdoc', module='livingdoc-annotations', version='1.10')
)

Scala SBT

libraryDependencies += "ch.ifocusit.livingdoc" % "livingdoc-annotations" % "1.10"

Leiningen

[ch.ifocusit.livingdoc/livingdoc-annotations "1.10"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

Read CONTRIBUTING file to contrib and check the the backlog on the trello board : https://trello.com/b/pabtQSZG/living-documentation

Living documentation tools

This project is intended to provide some tools to allow a nice Living Documentation.

It based on Asciidoctor, Plantuml Builder, and other nice tools…​

See examples to show the powerfull ! You’ll be able to generate beautiful documents with a simple configuration. Create a living documentation from the code automatically. Easily customizable.

With or without annotations.

This java project is made of :

1. Some java annotations (like UbiquitousLanguage annotation), but not mandatory

2. A fully customizable maven plugin

Generate a conception diagram (svg format with link supported !)

And a business glossary (with asciidoc syntax, also in table format)

like this example : https://github.com/jboz/living-documentation/tree/master/livingdoc-examples/microservice/

Add gherkin description :

You can also integrate gherkin files like this example : Microservice example generated index file

Also allow to publish generated docs to confluence :

Publish specific HTML version to Altassian Conlluence Server.

With a light maven configuration :

<plugin>
    <groupId>ch.ifocusit.livingdoc</groupId>
    <artifactId>livingdoc-maven-plugin</artifactId>
    <version>1.2</version>
    <executions>
        <execution>
            <id>class-diagram</id>
            <phase>package</phase>
            <goals>
                <goal>diagram</goal>
                <goal>glossary</goal>
            </goals>
        </execution>
    </executions>
    <configuration>
        <packageRoot>ch.ifocusit.telecom.domain</packageRoot>
        <interactive>true</interactive>
        <excludes>
            <exclude>.*domain.common.*</exclude>
        </excludes>
    </configuration>
</plugin>

See livingdoc-examples for more uses cases.

Coin des développeurs : readme développeur

Versions

Version
1.10 May 18, 2018
1.9 Sep 6, 2017
1.8 Sep 6, 2017
1.7 Aug 23, 2017
1.6 Aug 17, 2017
1.5 Aug 15, 2017
1.4 Aug 7, 2017
1.3 Aug 7, 2017
1.2 Jun 28, 2017
1.1 Jun 27, 2017
1.0 Jun 26, 2017