Permalink
Fetching contributors…
Cannot retrieve contributors at this time
85 lines (64 sloc) 2.61 KB

Scanner for PlantUML files

Accepts all files with the given suffix (Default: puml, adoc).

Table 1. Configuration parameters
Name Description

jqassistant.plugin.plantuml.suffixes

Optional: suffixes of files which should be scanned. Default: puml, adoc

:File:PlantUml

Represents a file containing PlantUML diagram descriptions.

Table 2. Properties
Name Description

fileName

The file path relative to the given scan start directory, e.g. '/asciidoc/plantuml.adoc'.

Table 3. Relations
Name Target label(s) Cardinality Description

CONTAINS

[:PlantUml:Element]

0..n

PlantUML diagram descriptions contained in this file

:PlantUml:ClassDiagram

Represents a PlantUML class diagram description.

Currently not used. (Will contain elements like packages.)

:PlantUml:Package:Element

Represents a PlantUML class diagram package.

Table 4. Properties
Name Description

fqn

Fully qualified name, e.g. 'java.lang'

Table 5. Relations
Name Target label(s) Cardinality Description

MAY_DEPEND_ON

:PlantUml:Package:Element

0..n

References other packages this package is allowed to depend on

Packages

The following diagram shows the main building blocks of the PlantUML plugin and their interdependencies:

skinparam packageStyle rect

package de.kontext_e.jqassistant.plugin.plantuml {
    package de.kontext_e.jqassistant.plugin.plantuml.scanner {}
    package de.kontext_e.jqassistant.plugin.plantuml.store.descriptor {}
}

de.kontext_e.jqassistant.plugin.plantuml.scanner --> de.kontext_e.jqassistant.plugin.plantuml.store.descriptor

Package de.kontext_e.jqassistant.plugin.plantuml.scanner

Purpose: scans PlantUML and Asciidoc files and imports class diagram packages into the database

Table 6. Open discussion topics

Can only scan class diagrams

Maybe other diagrams will follow if needed for rules or executable architecture documentation

Does only scan packages of class diagrams and ignores classes

 Should be enough for the architecture

Uses own syntax parser and not the plantuml.jar

Mostly because the PlantUML source is a mess

Package de.kontext_e.jqassistant.plugin.plantuml.store.descriptor

Purpose: the XO data model