mirror of
https://github.com/octoleo/plantuml.git
synced 2024-11-21 20:45:10 +00:00
Merge pull request #1603 from The-Lum/ImproveDoc
docs: improve doc (JavaDoc, GH) [`package-info.java`, `readme.md`] (for `Smetana`, `API/CheerpJ`)
This commit is contained in:
PlantUML
GitHub
commit
1cfab8ba80
7
src/com/plantuml/api/cheerpj/package-info.java
Normal file
7
src/com/plantuml/api/cheerpj/package-info.java
Normal file
@ -0,0 +1,7 @@
|
||||
/**
|
||||
* Provides classes used to manage PlantUML with the
|
||||
* <a href="https://labs.leaningtech.com/cheerpj3" target="_top">
|
||||
* CheerpJ</a> API.
|
||||
*
|
||||
*/
|
||||
package cheerpj;
|
||||
16
src/com/plantuml/api/cheerpj/readme.md
Normal file
16
src/com/plantuml/api/cheerpj/readme.md
Normal file
@ -0,0 +1,16 @@
|
||||
# Directory Documentation for `cheerpj`
|
||||
|
||||
## Description
|
||||
This package provides classes used to manage [CheerpJ](https://labs.leaningtech.com/cheerpj3) API.
|
||||
|
||||
## Reference
|
||||
- [CheerpJ](https://labs.leaningtech.com/cheerpj3)
|
||||
|
||||
## Use by
|
||||
- :octocat: [plantuml/plantuml-core](https://github.com/plantuml/plantuml-core)
|
||||
- on [`/plantuml-core/src/main/java`](https://github.com/plantuml/plantuml-core/tree/main/plantuml-core/src/main/java)
|
||||
- :octocat: [plantuml/plantuml.js](https://github.com/plantuml/plantuml.js)
|
||||
|
||||
## Demonstration
|
||||
- [`plantuml-core/raw.html`](https://plantuml.github.io/plantuml-core/raw.html)
|
||||
- [`plantuml.js`](https://plantuml.github.io/plantuml.js/)
|
||||
12
src/gen/package-info.java
Normal file
12
src/gen/package-info.java
Normal file
@ -0,0 +1,12 @@
|
||||
/**
|
||||
* This package is part of Smetana:
|
||||
* the internal port (from <code>C</code> to <code>Java</code>)
|
||||
* of <a href="https://graphviz.org"target="_top">GraphViz/Dot</a>
|
||||
* in <a href="https://plantuml.com/smetana02" target="_top">plantuml</a>.
|
||||
*
|
||||
* @see h
|
||||
* @see smetana.core
|
||||
* @see net.sourceforge.plantuml.sdot
|
||||
*
|
||||
*/
|
||||
package gen;
|
||||
28
src/gen/readme.md
Normal file
28
src/gen/readme.md
Normal file
@ -0,0 +1,28 @@
|
||||
# Directory Documentation for `gen`
|
||||
|
||||
## Description
|
||||
This package is part of Smetana: the internal port (from `C` to `Java`) of [GraphViz/Dot](https://graphviz.org) in [plantuml](https://plantuml.com/smetana02).
|
||||
|
||||
## Link
|
||||
- [Smetana](https://plantuml.com/smetana02) and :octocat: [plantuml/smetana](https://github.com/plantuml/smetana)
|
||||
- [`src/h`](../h)
|
||||
- [`src/gen`](../gen)
|
||||
- [`src/smetana/core`](../smetana/core)
|
||||
|
||||
## Reference
|
||||
- [Graphviz](https://graphviz.org)
|
||||
- [Graphviz DOT Language](https://www.graphviz.org/doc/info/lang.html)
|
||||
- [Graphviz _(on GitLab)_](https://gitlab.com/graphviz/graphviz/)
|
||||
- [Graphviz _(on Wikipedia)_](https://en.wikipedia.org/wiki/Graphviz)
|
||||
|
||||
## Credit
|
||||
- :octocat: [plantuml/smetana](https://github.com/plantuml/smetana)
|
||||
|
||||
## Internaly use by
|
||||
- [`plantuml/sdot`](../net/sourceforge/plantuml/sdot)
|
||||
- [`plantuml/gitlog/SmetanaForGit.java`](../net/sourceforge/plantuml/gitlog/SmetanaForGit.java)
|
||||
- [`plantuml/jsondiagram/SmetanaForJson.java`](../net/sourceforge/plantuml/jsondiagram/SmetanaForJson.java)
|
||||
|
||||
## Misc.
|
||||
- [Bedřich Smetana _(on Wikipedia)_](https://en.wikipedia.org/wiki/Bed%C5%99ich_Smetana)
|
||||
- [Smetana _(on Wikipedia)_](https://en.wikipedia.org/wiki/Smetana_(disambiguation))
|
||||
12
src/h/package-info.java
Normal file
12
src/h/package-info.java
Normal file
@ -0,0 +1,12 @@
|
||||
/**
|
||||
* This package is part of Smetana:
|
||||
* the internal port (from <code>C</code> to <code>Java</code>)
|
||||
* of <a href="https://graphviz.org"target="_top">GraphViz/Dot</a>
|
||||
* in <a href="https://plantuml.com/smetana02" target="_top">plantuml</a>.
|
||||
*
|
||||
* @see gen
|
||||
* @see smetana.core
|
||||
* @see net.sourceforge.plantuml.sdot
|
||||
*
|
||||
*/
|
||||
package h;
|
||||
32
src/h/readme.md
Normal file
32
src/h/readme.md
Normal file
@ -0,0 +1,32 @@
|
||||
# Directory Documentation for `h`
|
||||
|
||||
## Description
|
||||
This package is part of Smetana: the internal port (from `C` to `Java`) of [GraphViz/Dot](https://graphviz.org) in [plantuml](https://plantuml.com/smetana02).
|
||||
|
||||
Port of the `C header` (`.h`) of Graphviz on Java:
|
||||
- `EN` for `enumeration` or `enum`
|
||||
- `ST` for `structure`
|
||||
|
||||
## Link
|
||||
- [Smetana](https://plantuml.com/smetana02) and :octocat: [plantuml/smetana](https://github.com/plantuml/smetana)
|
||||
- [`src/h`](../h)
|
||||
- [`src/gen`](../gen)
|
||||
- [`src/smetana/core`](../smetana/core)
|
||||
|
||||
## Reference
|
||||
- [Graphviz](https://graphviz.org)
|
||||
- [Graphviz DOT Language](https://www.graphviz.org/doc/info/lang.html)
|
||||
- [Graphviz _(on GitLab)_](https://gitlab.com/graphviz/graphviz/)
|
||||
- [Graphviz _(on Wikipedia)_](https://en.wikipedia.org/wiki/Graphviz)
|
||||
|
||||
## Credit
|
||||
- :octocat: [plantuml/smetana](https://github.com/plantuml/smetana)
|
||||
|
||||
## Internaly use by
|
||||
- [`plantuml/sdot`](../net/sourceforge/plantuml/sdot)
|
||||
- [`plantuml/gitlog/SmetanaForGit.java`](../net/sourceforge/plantuml/gitlog/SmetanaForGit.java)
|
||||
- [`plantuml/jsondiagram/SmetanaForJson.java`](../net/sourceforge/plantuml/jsondiagram/SmetanaForJson.java)
|
||||
|
||||
## Misc.
|
||||
- [Bedřich Smetana _(on Wikipedia)_](https://en.wikipedia.org/wiki/Bed%C5%99ich_Smetana)
|
||||
- [Smetana _(on Wikipedia)_](https://en.wikipedia.org/wiki/Smetana_(disambiguation))
|
||||
12
src/smetana/core/package-info.java
Normal file
12
src/smetana/core/package-info.java
Normal file
@ -0,0 +1,12 @@
|
||||
/**
|
||||
* This package is part of Smetana:
|
||||
* the internal port (from <code>C</code> to <code>Java</code>)
|
||||
* of <a href="https://graphviz.org"target="_top">GraphViz/Dot</a>
|
||||
* in <a href="https://plantuml.com/smetana02" target="_top">plantuml</a>.
|
||||
*
|
||||
* @see h
|
||||
* @see gen
|
||||
* @see net.sourceforge.plantuml.sdot
|
||||
*
|
||||
*/
|
||||
package core;
|
||||
28
src/smetana/core/readme.md
Normal file
28
src/smetana/core/readme.md
Normal file
@ -0,0 +1,28 @@
|
||||
# Directory Documentation for `core`
|
||||
|
||||
## Description
|
||||
This package is part of Smetana: the internal port (from `C` to `Java`) of [GraphViz/Dot](https://graphviz.org) in [plantuml](https://plantuml.com/smetana02).
|
||||
|
||||
## Link
|
||||
- [Smetana](https://plantuml.com/smetana02) and :octocat: [plantuml/smetana](https://github.com/plantuml/smetana)
|
||||
- [`src/h`](../h)
|
||||
- [`src/gen`](../gen)
|
||||
- [`src/smetana/core`](../smetana/core)
|
||||
|
||||
## Reference
|
||||
- [Graphviz](https://graphviz.org)
|
||||
- [Graphviz DOT Language](https://www.graphviz.org/doc/info/lang.html)
|
||||
- [Graphviz _(on GitLab)_](https://gitlab.com/graphviz/graphviz/)
|
||||
- [Graphviz _(on Wikipedia)_](https://en.wikipedia.org/wiki/Graphviz)
|
||||
|
||||
## Credit
|
||||
- :octocat: [plantuml/smetana](https://github.com/plantuml/smetana)
|
||||
|
||||
## Internaly use by
|
||||
- [`plantuml/sdot`](../net/sourceforge/plantuml/sdot)
|
||||
- [`plantuml/gitlog/SmetanaForGit.java`](../net/sourceforge/plantuml/gitlog/SmetanaForGit.java)
|
||||
- [`plantuml/jsondiagram/SmetanaForJson.java`](../net/sourceforge/plantuml/jsondiagram/SmetanaForJson.java)
|
||||
|
||||
## Misc.
|
||||
- [Bedřich Smetana _(on Wikipedia)_](https://en.wikipedia.org/wiki/Bed%C5%99ich_Smetana)
|
||||
- [Smetana _(on Wikipedia)_](https://en.wikipedia.org/wiki/Smetana_(disambiguation))
|
||||
Loading…
Reference in New Issue
Block a user