search

project-mahiwa / mahiwa-backend

mahiwaのバックエンド
GNU Lesser General Public License v2.1
0 stars 0 forks source link

[✨Feature]: ドキュメント自動生成を実現する #79

Open usuyuki opened 11 months ago

usuyuki commented 11 months ago

✨ 概要

コメントから生成できるとドキュメントの陳腐化を防げて大変良い．

なぜ必要

コメント→MarkDownできるツール探す．

備考

usuyuki commented 11 months ago

GoとRustはパッケージマネージャがやってくれてる． ライブラリにしないmahiwa-backendは自前で用意が必要．

usuyuki commented 11 months ago

GitHubアクションにて， Cコメント→markdownにする→project-mahiwa/documentにPRを自動で出す みたいにしたい．

usuyuki commented 11 months ago

pioでdoxygen使うの難しそう というより，pioでライブラリにはしないけど，一部の関数だけドキュメント化するっていうのが無理そう

usuyuki commented 11 months ago

そもそもwasm3への関数登録がマクロによるものなので，できるか難しい

usuyuki commented 11 months ago

自前で作るしか無い？ Cの解析ノウハウはライブラリ自動生成でも役立つので，作ってみるのがありかもしれない．時間が無限にあれば．

usuyuki commented 11 months ago

pioでのdoxygen使用例

https://github.com/Erriez/ErriezGithubActionsPlatformIODoxygen/blob/main/.github/workflows/actions.yml https://github.com/Erriez/ErriezGithubActionsPlatformIODoxygen/blob/main/Doxyfile

https://github.com/HeLiBloks/PlatformIO-Template/blob/master/Makefile

usuyuki commented 11 months ago

doxygenはmarkdown出せそう https://zenn.dev/mebiusbox/articles/bca221e0cac13f