octoleo
/
plantuml
mirror of https://github.com/octoleo/plantuml.git
1
0
Fork 0
Code Issues Releases Wiki Activity

docs: add `package-info.java` and `readme.md` 

For `Smetana`:
- `src/h`
- `src/gen`
- `src/smetana/core`
This commit is contained in:
The-Lum 2023-11-14 14:34:15 +00:00
parent 4f46b6726e
commit 91d46a866e
6 changed files with 124 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/gen/package-info.java Normal file
View 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
View 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
View 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
View 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
View 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
View 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))