Conversation
Converts a description written in doxygen format to dartdoc format. ex) dart run ./scripts/convert_description.dart lib/src/bindings/6.0/generated_bindings.dart before ```dart /// @brief Gets the last error code in the thread. /// @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif /// @details This function retrieves the last error code which is set by set_last_result() /// @return One of #tizen_error_e /// @see #tizen_error_e /// @see set_last_result() int get_last_result() { return _get_last_result(); } ``` after ```dart /// Gets the last error code in the thread. /// /// This function retrieves the last error code which is set by set_last_result() /// /// **Since Tizen:** /// - Mobile 2.3; Wearable 2.3.1 /// /// **Returns:** /// - One of `tizen_error_e` /// /// **See also:** /// - `tizen_error_e` /// - `set_last_result()` int get_last_result() { return _get_last_result(); } ```
There was a problem hiding this comment.
Code Review
This pull request introduces a useful script for converting Doxygen-style comments to Dartdoc format. The implementation is comprehensive and covers a wide range of Doxygen tags. I've provided a few suggestions to improve maintainability, correctness of the generated documentation, and usability of the script. Specifically, I've commented on improving a complex regular expression, handling code block languages dynamically, correcting the usage message, and adding missing documentation for public functions as per the repository's style guide.
|
/gemini review |
There was a problem hiding this comment.
Code Review
This pull request introduces a new Dart script for converting Doxygen-style comments into Dartdoc format. The script is quite comprehensive and handles many Doxygen features. My review focuses on improving the script's performance and robustness. The main feedback points are related to avoiding repeated creation of RegExp objects within loops, which is a performance concern, and strengthening the logic for parsing Dart code to make it less fragile. These changes will make the script more efficient and reliable.
This script was taken from flutter-tizen#62. And I converted all binding code from Doxygen format to DartDoc format.
Converts a description written in doxygen format to dartdoc format.
ex)
dart run ./scripts/convert_description.dart lib/src/bindings/6.0/generated_bindings.dart
before
after