Read-only mirrors. Development, issues and pull requests are on GitHub.

summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorLeitwolf112026-11-15 17:33:49 +0300
committerLeitwolf112026-11-15 17:33:49 +0300
commit1baf19e8ed000f645028318bec247fb0d5c66936 (patch)
treeec518d93ac2115c96f0b61b3fc0211cb0e37bd35
parent4decba594424532945a35494f52283515d67b579 (diff)
downloadprogmasoft-cpp-docs/core-c-guidelines.tar.gz
Give the C sections of the README their own headingsdocs/core-c-guidelines
Codacy's markdownlint found the C section's Contents and The short version headings repeating those of the C++ section, and a code span that starts with a space in Comments and documentation. Co-Authored-By: Claude Opus 5.5 <[email protected]> Claude-Session: https://claude.ai/code/session_01Ji7xZMYjc4zankoc7hGBE1
-rw-r--r--Progmasoft_Core_C_Coding_Guidelines/C11/COMMENTS-AND-DOCUMENTATION.md4
-rw-r--r--README.md4
2 files changed, 4 insertions, 4 deletions
diff --git a/Progmasoft_Core_C_Coding_Guidelines/C11/COMMENTS-AND-DOCUMENTATION.md b/Progmasoft_Core_C_Coding_Guidelines/C11/COMMENTS-AND-DOCUMENTATION.md
index 98a8ea1..c6cf685 100644
--- a/Progmasoft_Core_C_Coding_Guidelines/C11/COMMENTS-AND-DOCUMENTATION.md
+++ b/Progmasoft_Core_C_Coding_Guidelines/C11/COMMENTS-AND-DOCUMENTATION.md
@@ -43,8 +43,8 @@ The parts come in this order; a part that is not needed is left out:
8. `@deprecated`
9. `@see`
-`@param` and `@return` lines stand together, with no blank line between them; other parts may be separated by an empty
-` *` line.
+`@param` and `@return` lines stand together, with no blank line between them; other parts may be separated by a
+line that holds only the `*` of the comment.
```c
/**
diff --git a/README.md b/README.md
index 449275e..3885ba5 100644
--- a/README.md
+++ b/README.md
@@ -85,7 +85,7 @@ records a deviation. [Contributing](CONTRIBUTING.md) explains how to propose a c
The guidelines for C11, in `Progmasoft_Core_C_Coding_Guidelines/`. They are a style of their own, not the C part of the
C++ guidelines: a C interface of a C++ library follows the C++ guidelines, a C project follows these.
-### Contents
+### Contents of the C guidelines
| Chapter | Covers |
| --- | --- |
@@ -104,7 +104,7 @@ C++ guidelines: a C interface of a C++ library follows the C++ guidelines, a C p
With one version, the chapters are all in `C11/`. [`index.json`](Progmasoft_Core_C_Coding_Guidelines/index.json) lists
them in the same form as the C++ index.
-### The short version
+### The C guidelines in short
- ISO C11 with `-pedantic-errors`, no extensions but `#pragma once` and `extern "C"`; Clang, `clang-format` and
`clang-tidy` 23.