Skip to content

Commit 713a96d

Browse files
committed
docs: API documentation
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
1 parent e888b67 commit 713a96d

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,10 @@ $bom->getComponents()->addItems(
9393
## API documentation
9494

9595
There is no pre-rendered documentation at the time.
96-
Instead, there is a prepared config for [phpDoc3](https://docs.phpdoc.org/guide/getting-started/index.html)
97-
that you can use to generate the docs for yourself.
96+
Instead, there are code annotations, so that your IDE and tools may pick up the documentation when you use it downstream.
97+
98+
Additionally, there is a prepared config for [phpDoc3](https://docs.phpdoc.org/guide/getting-started/index.html)
99+
that you can use to generate the docs for yourself.
98100

99101
## Conflicts
100102

0 commit comments

Comments
 (0)