add cpp documentation #20
Conversation
src/pages/index.js
Outdated
| @@ -324,7 +324,7 @@ function HomepageHeader() { | |||
| <div style={{ display: "flex", flexDirection: "row", justifyContent: "space-evenly", flexWrap: "wrap" }}> | |||
| <div className={styles.buttons}> | |||
| <Link | |||
| className="button button--secondary button--md margin-bottom--md" | |||
| className="button button--secondary button--md ma rgin-bottom--md" | |||
There was a problem hiding this comment.
what is this change about?
There was a problem hiding this comment.
oh, maybe it change when i build,i will check this
|
The link is not loading when I build the website. Can you add information on how to build the static files?
|
|
when you build at local machine,you should change the link to "http://localhost:3000/cpp/cpp-api.html" ，and "npm run build" 、“npm run serve" |
|
Ah ok, could it be possible to have the build script for the documentation? |
|
The search bar does not work. Could we maybe generate it without the search bar? |
|
Ok, I delete search bar |
|
Could you please add the script to use to generate the documentation? I can't merge this PR otherwise |
|
Do you mean the script of the cpp document? I use the Doxygen template, but the main content of the document is written in html, not generated from the Markdown document. If you want to modify the document, you only need to modify cpp-api.html. Of course, I provide a generated script 4b6b792#diff-f1cf1fbc3fe2fc86148347689881cb23764d3981c211d3bbd6573f9d5869622d, which can back up the main content of the cpp document and regenerate the document. You can use it to add some js code and regenerate the document. |
|
I don't understand is this documentation not generated from code? Did you write it yourself? |
|
Yes, Doxygen can only generate documentation from C++ code, but dora's C++ interface is declared in rust, and files like bindings.cc are generated only when used, so I can only use this template to write the document myself. |
|
So, I opened a PR: dora-rs/dora#611 to be able to auto generate C++ documentation. Could you check it out and paste your already written documentation within the rust code so that we can have only one source of documentation. |
|
Okay, it looks great. |
This is a cpp document written according to doxygen.