================ @@ -430,26 +441,31 @@ Documenting your check The ``add_new_check.py`` script creates entries in the `release notes <https://clang.llvm.org/extra/ReleaseNotes.html>`_, the list of -checks and a new file for the check documentation itself. It is recommended that you -have a concise summary of what your check does in a single sentence that is repeated -in the release notes, as the first sentence in the doxygen comments in the header file -for your check class and as the first sentence of the check documentation. Avoid the -phrase "this check" in your check summary and check documentation. - -If your check relates to a published coding guideline (C++ Core Guidelines, SEI CERT, etc.) -or style guide, provide links to the relevant guideline or style guide sections in your -check documentation. - -Provide enough examples of the diagnostics and fix-its provided by the check so that a -user can easily understand what will happen to their code when the check is run. -If there are exceptions or limitations to your check, document them thoroughly. This -will help users understand the scope of the diagnostics and fix-its provided by the check. - -Building the target ``docs-clang-tools-html`` will run the Sphinx documentation generator -and create HTML documentation files in the tools/clang/tools/extra/docs/html directory in -your build tree. Make sure that your check is correctly shown in the release notes and the -list of checks. Make sure that the formatting and structure of your check's documentation -look correct: there is no trailing whitespaces and lines are no longer than 80 characters. + +checks and a new file for the check documentation itself. It is recommended +that you have a concise summary of what your check does in a single sentence +that is repeated in the release notes, as the first sentence in the doxygen +comments in the header file for your check class and as the first sentence of +the check documentation. Avoid the phrase "this check" in your check summary +and check documentation. + +If your check relates to a published coding guideline (C++ Core Guidelines, +SEI CERT, etc.) or style guide, provide links to the relevant guideline or +style guide sections in your check documentation. + +Provide enough examples of the diagnostics and fix-its provided by the check so +that a user can easily understand what will happen to their code when the check +is run. If there are exceptions or limitations to your check, document them +thoroughly. This will help users understand the scope of the diagnostics and +fix-its provided by the check. + +Building the target ``docs-clang-tools-html`` will run the Sphinx documentation +generator and create HTML documentation files in the +tools/clang/tools/extra/docs/html directory in your build tree. ---------------- EugeneZelenko wrote:
Will be good idea to highlight `tools/clang/tools/extra/docs/html `. https://github.com/llvm/llvm-project/pull/168722 _______________________________________________ cfe-commits mailing list [email protected] https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
