Skip to content

Commit

Permalink
attempt to generate javadocs
Browse files Browse the repository at this point in the history
  • Loading branch information
alexdmiller committed Jan 6, 2025
1 parent d376c17 commit 9bc174a
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/deploy_website.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
python-version: 3.x

- name: Install dependencies
run: pip install mkdocs-material
run: pip install mkdocs-material mkdocs-autodoc mkdocstrings[java]

- name: Build website
run: mkdocs build
Expand Down
16 changes: 15 additions & 1 deletion docs/how-to-multiple-projectors.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
# How-to: Use multiple projectors

TODO
TODO

``` java
myShape = createShape(BOX, 150);
mapper = new ShapeMapper(this);
mappedShape = mapper.addShape("box", myShape, 2);
```

``` java
for (Mapping mapping : mappedShape.getMappings()) {
mapping.beginMapping();
shape(myShape);
mapping.endMapping();
}
```
3 changes: 3 additions & 0 deletions docs/reference.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Reference

::: spacefiller.shapemapper.ShapeMapper
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ copyright: MIT Licence.

plugins:
- offline
- mkdocstrings

nav:
- Home: index.md
Expand Down

0 comments on commit 9bc174a

Please sign in to comment.