Add api format convert script#70
Conversation
|
Note Gemini is unable to generate a review for this pull request due to the file types involved not being currently supported. |
There was a problem hiding this comment.
Have you actually create the API documentation?
You can check the documentation with a Python server.
dart doc
cd doc
python3 -m http.server 8000
firefox http://127.0.0.1:8000/
Many warning messages are being displayed. It is recommended to address any warnings that can be improved. I also recommend improving the script to prevent the addition of documentation that is not migrated to Dart.
Additionally, if you navigate to index.html and click Libraries -> 6.0/tizen, all APIs from tizen_interop_6_0/ will be displayed on a single page. I believe that while proceeding with the doc format conversion, you can categorize the code by module within this PR.
Finally, please upload only script first for Gemini's code review. Once the script is successfully merged, you may update all documentation afterward. With the current method, you cannot receive assistance from the review bot.
09954c3 to
1e17393
Compare
|
/gemini review |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a script, convert_description.dart, to automate the conversion of Doxygen-style comments into Dartdoc format for Tizen bindings. It also updates generate_tizen.py to produce versioned library names and adds relevant documentation to the README.md. Feedback focuses on the comment conversion logic, specifically addressing the potential corruption of C code examples within code blocks due to improper handling of newline escapes and the flattening of Markdown-style lists during line merging.
7941df1 to
b03bb61
Compare
|
/gemini review |
There was a problem hiding this comment.
Code Review
This pull request introduces a new Dart script, convert_description.dart, to automate the conversion of Doxygen-style comments into standard Dartdoc format. It also updates the documentation and generation scripts to support version-specific library naming and improved API documentation. The review feedback suggests using the path package for more robust file path manipulation and optimizing performance by hoisting a regular expression to a top-level constant.
9d6e2e1 to
35bea1f
Compare
Thank you for the review. |
JSUYA
left a comment
JSUYA
left a comment
There was a problem hiding this comment.
LGTM
I confirmed that the document is generated correctly according to the dart doc type.
2 participants
This script is taken from #62 and converts all binding code from Doxygen format to DartDoc format.