Skip to content

Conversation

@n-kawauchi
Copy link

Identify the Bug

Link to #319

  • 指摘されたPortBase.pyの2464行目コード部分は以下の通り
2463         def __init__(self, id_):
2464             """ 
2465              \param id_(string)
2466             """ 
2467             self._id = id_
  • これはDoxygen用に \param と記述している部分で、
    • Python の文字列 → \p を無効なエスケープと解釈する
    • Doxygen の構文 → \param を必要としている

Description of the Change

  • 二重バックスラッシュに変更する
"""
\\param id_ (string)
"""

Verification

  • 修正ソースからdebパッケージを生成し、これでインストールした環境でサンプルRTCを実行し、SyntaxWarningが出ないことを確認した(Ubuntu24.04)
  • 修正ソースからクラスリファレンスを生成し、index.htmlを実行してブラウザ上で確認したところ問題なく表示されることを確認した
  • Did you succeed the build?
  • No warnings for the build?
  • Have you passed the unit tests?

@n-kawauchi n-kawauchi requested a review from n-ando August 28, 2025 06:54
@n-kawauchi n-kawauchi self-assigned this Aug 28, 2025
@n-ando n-ando merged commit ef13050 into OpenRTM:master Sep 1, 2025
0 of 4 checks passed
@n-kawauchi n-kawauchi deleted the fix/docstring-escape-doxygen branch October 15, 2025 02:31
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