Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix compiler warnings for -Wdocumentation and related warnings #1328

Merged
merged 1 commit into from
Jan 20, 2024

Conversation

ma8ma
Copy link
Collaborator

@ma8ma ma8ma commented Jan 20, 2024

Doxygenのコメントに誤りがあるとコンパイラーに指摘されたため修正します。

clang-17のレポート (file pathを一部省略)

src/jdlib/miscutil.cpp:1071:26: warning: HTML tag 'span' requires an end tag [-Wdocumentation-html]
 1071 |  * @details `<mark>`と`<span>`タグの色を設定して文字参照をデコードして返す。
      |                        ~^~~~~
src/jdlib/miscutil.h:105:42: warning: unknown command tag name [-Wdocumentation-unknown-command]
  105 |     /// str に含まれる改行文字(`\r\n`)を replace に置き換え
      |                                 ^~
src/main.cpp:479:15: warning: parameter 'hint' not found in the function declaration [-Wdocumentation]
  479 |  * @param[in] hint  未使用
      |               ^~~~

Doxygenのコメントに誤りがあるとコンパイラーに指摘されたため修正します。

clang-17のレポート (file pathを一部省略)
```
src/jdlib/miscutil.cpp:1071:26: warning: HTML tag 'span' requires an end tag [-Wdocumentation-html]
 1071 |  * @details `<mark>`と`<span>`タグの色を設定して文字参照をデコードして返す。
      |                        ~^~~~~
src/jdlib/miscutil.h:105:42: warning: unknown command tag name [-Wdocumentation-unknown-command]
  105 |     /// str に含まれる改行文字(`\r\n`)を replace に置き換え
      |                                 ^~
src/main.cpp:479:15: warning: parameter 'hint' not found in the function declaration [-Wdocumentation]
  479 |  * @param[in] hint  未使用
      |               ^~~~
```
@ma8ma ma8ma added the bug バグの追跡 label Jan 20, 2024
@ma8ma ma8ma merged commit fe970fb into master Jan 20, 2024
20 checks passed
@ma8ma ma8ma deleted the fix-compiler-warnings-for-Wdocumentation branch January 20, 2024 14:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug バグの追跡
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

1 participant