grammar, better spacing for documentation section
This commit is contained in:
parent
188b9c1879
commit
2a9ed1571a
|
@ -197,8 +197,9 @@ public Image getImage(URL url, String name) {
|
||||||
|
|
||||||
# Frontend
|
# Frontend
|
||||||
|
|
||||||
Documenting the frontend is quite hard, but since there will be also logic hid inside the frontend that too will need to be documented.
|
Documenting the frontend is quite hard, but since there will be state management and complicated classes for managing data it has to be all written down.
|
||||||
For methods and classes, JSDoc for javascript is the perfect fit.
|
|
||||||
|
**For methods and classes, JSDoc for javascript is the perfect fit.**
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
/**
|
/**
|
||||||
|
@ -213,7 +214,8 @@ function is_even(number): boolean {
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
For user action descriptions and flow charts [Mermaid](https://github.com/mermaid-js/mermaid) has to be used. We can describe actions that are then generated into SVGs, PNGs, or other formats. They neatly integrate into Forgejo too.
|
**For user action descriptions and flow charts [Mermaid](https://github.com/mermaid-js/mermaid) has to be used.**
|
||||||
|
We can describe actions that are then generated into SVGs, PNGs, or other formats. It also neatly integrates into Forgejo.
|
||||||
|
|
||||||
_An example of a state description_
|
_An example of a state description_
|
||||||
|
|
||||||
|
|
Reference in a new issue