Compare commits

..

1 Commits

Author SHA1 Message Date
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
CI API Docs / Test Python API Documentation Generation (pull_request) Successful in 26s
CI Code / Check coding style (pull_request) Successful in 33s
CI Code / Check spelling (pull_request) Successful in 20s
CI Code / Linux (debian) (pull_request) Successful in 12m26s
CI Code / Linux (ubuntu) (pull_request) Successful in 12m46s
CI Code / Linux (arch) (pull_request) Successful in 15m17s
CI API Docs / Test C API Documentation Generation (push) Successful in 28s
CI API Docs / Test Python API Documentation Generation (push) Successful in 29s
- 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

View File

@@ -1,4 +1,4 @@
/** @file profapi.h
/** @file profapi.h
* @brief C Plugin API for CProof.
*
* This header defines functions for CProof plugins to interact with the console,
@@ -16,11 +16,6 @@
* @see profhooks.h
*/
/** @mainpage CProof Plugin API and Hooks
* API functions: @ref profapi.h
* Hooks: @ref profhooks.h
*/
/** Window handle for referencing plugin-created windows. */
typedef char* PROF_WIN_TAG;