Skip to content

Add api format convert script#70

Merged
seungsoo47 merged 6 commits into
flutter-tizen:mainfrom
seungsoo47:dev.tizen_interop.convert_docs.260416
Apr 28, 2026
Merged

Add api format convert script#70
seungsoo47 merged 6 commits into
flutter-tizen:mainfrom
seungsoo47:dev.tizen_interop.convert_docs.260416

Conversation

@seungsoo47

@seungsoo47 seungsoo47 commented Apr 16, 2026

Copy link
Copy Markdown
Contributor

This script is taken from #62 and converts all binding code from Doxygen format to DartDoc format.

@gemini-code-assist

Copy link
Copy Markdown

Note

Gemini is unable to generate a review for this pull request due to the file types involved not being currently supported.

@JSUYA JSUYA left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@seungsoo47
seungsoo47 force-pushed the dev.tizen_interop.convert_docs.260416 branch from 09954c3 to 1e17393 Compare April 23, 2026 08:58
@seungsoo47

Copy link
Copy Markdown
Contributor Author

/gemini review

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread scripts/convert_description.dart
Comment thread scripts/convert_description.dart
Comment thread scripts/convert_description.dart Outdated
@seungsoo47
seungsoo47 force-pushed the dev.tizen_interop.convert_docs.260416 branch from 7941df1 to b03bb61 Compare April 23, 2026 10:41
@seungsoo47

Copy link
Copy Markdown
Contributor Author

/gemini review

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread scripts/convert_description.dart Outdated
Comment thread scripts/convert_description.dart Outdated
@seungsoo47
seungsoo47 force-pushed the dev.tizen_interop.convert_docs.260416 branch from 9d6e2e1 to 35bea1f Compare April 24, 2026 08:02
@seungsoo47

seungsoo47 commented Apr 24, 2026

Copy link
Copy Markdown
Contributor Author

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.

Thank you for the review.
As you suggested, I have updated them by removing warnings and categorizing the code.
I will upload the modified generate_bindings_{module}.dart for all tizen version after you review.

@JSUYA JSUYA left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM
I confirmed that the document is generated correctly according to the dart doc type.

@seungsoo47
seungsoo47 merged commit 5987863 into flutter-tizen:main Apr 28, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants