devs/cproof

Fix documentation so it does not cause warnings by parsers #33

Manually merged

jabber.developer merged 5 commits from docs/minor-fixes into master

2025-09-30 08:59:20 +00:00

Author	SHA1	Message	Date
Jabber Developer	40dd773c6a	docs(apidocs/c): improve profapi.h and profhooks.h comments All checks were successful CI API Docs / Test C API Documentation Generation (pull_request) Successful in 23s Details CI API Docs / Test Python API Documentation Generation (pull_request) Successful in 26s Details CI Code / Check coding style (pull_request) Successful in 33s Details CI Code / Check spelling (pull_request) Successful in 20s Details CI Code / Linux (debian) (pull_request) Successful in 12m26s Details CI Code / Linux (ubuntu) (pull_request) Successful in 12m46s Details CI Code / Linux (arch) (pull_request) Successful in 15m17s Details CI API Docs / Test C API Documentation Generation (push) Successful in 28s Details CI API Docs / Test Python API Documentation Generation (push) Successful in 29s Details - Enhanced file-level comments with concise descriptions - Added usage examples and aligned with Python prof module style - Updated function comments to remove tables, improve clarity - Replaced Profanity with CProof, preserved paths and method names	2025-09-23 14:07:32 +02:00
Jabber Developer	8849d9b79e	docs: move callbacks down All checks were successful CI API Docs / Test C API Documentation Generation (pull_request) Successful in 26s Details CI API Docs / Test Python API Documentation Generation (pull_request) Successful in 28s Details CI Code / Check coding style (pull_request) Successful in 36s Details CI Code / Check spelling (pull_request) Successful in 18s Details CI Code / Linux (debian) (pull_request) Successful in 13m40s Details CI Code / Linux (ubuntu) (pull_request) Successful in 14m9s Details CI Code / Linux (arch) (pull_request) Successful in 21m18s Details To improve readability of the docs	2025-09-22 23:05:45 +02:00
Jabber Developer	92cb930810	docs: Fix indentation All checks were successful CI API Docs / Test C API Documentation Generation (pull_request) Successful in 26s Details CI API Docs / Test Python API Documentation Generation (pull_request) Successful in 28s Details CI Code / Check coding style (pull_request) Successful in 35s Details CI Code / Check spelling (pull_request) Successful in 18s Details CI Code / Linux (debian) (pull_request) Successful in 13m38s Details CI Code / Linux (ubuntu) (pull_request) Successful in 16m18s Details CI Code / Linux (arch) (pull_request) Successful in 16m46s Details	2025-09-17 01:37:10 +02:00
Jabber Developer	9fd62e2304	ci: restructure and optimize execution conditions Some checks failed CI API Docs / Test C API Documentation Generation (pull_request) Successful in 26s Details CI API Docs / Test Python API Documentation Generation (pull_request) Failing after 28s Details CI Code / Check coding style (pull_request) Has been cancelled Details CI Code / Check spelling (pull_request) Has been cancelled Details CI Code / Linux (arch) (pull_request) Has been cancelled Details CI Code / Linux (debian) (pull_request) Has been cancelled Details CI Code / Linux (ubuntu) (pull_request) Has been cancelled Details - The code tests will ignore doc changes and vice versa. - The CI is split in 2 parts for clarity	2025-09-17 01:00:30 +02:00
Jabber Developer	c94263486f	docs(python): fix formatting to ensure correct parsing Fixes issues introduced in `052e168`, `4cdcf9a`, and other commits from PR #31.	2025-09-17 00:34:37 +02:00