Skip to content

Fix or disable warnings when building HTML documentation  #148

@bratpiorka

Description

@bratpiorka

Fix or disable warnings when building HTML documentation, see e.g. https://github.com/oneapi-src/unified-memory-framework/actions/runs/7503390412/job/20428040074:

building [html]: targets for 2 source files that are out of date
updating environment: [new config] 2 added, 0 changed, 0 removed
reading sources... [ 50%] api
reading sources... [100%] index

/home/runner/work/unified-memory-framework/unified-memory-framework/scripts/docs_config/api.rst:19: WARNING: Error when parsing function declaration.
If the function has no return type:
Error in declarator or parameters-and-qualifiers
Invalid C++ declaration: Expecting "(" in parameters-and-qualifiers. [error at 11]
UMF_EXPORT umf_result_t umfPoolCreate (const umf_memory_pool_ops_t *ops, umf_memory_provider_handle_t provider, void *params, umf_memory_pool_handle_t *hPool)
-----------^
If the function has a return type:
Error in declarator or parameters-and-qualifiers
If pointer to member declarator:
Invalid C++ declaration: Expected '::' in pointer to member (function). [error at 24]
UMF_EXPORT umf_result_t umfPoolCreate (const umf_memory_pool_ops_t *ops, umf_memory_provider_handle_t provider, void *params, umf_memory_pool_handle_t *hPool)
------------------------^
...

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions