Fix docstring(s) attributed to the flamegpu namespace #1169
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I've not thoroughly checked the full docs, there are too many pages, but I skipped all the explcitly documented namespaces in doxygen html output. |
Robadob
reviewed
Jan 5, 2024
Robadob
reviewed
Jan 5, 2024
Robadob
approved these changes
Jan 5, 2024
|
Fair, wasn't aware the difference!
…On Fri, 5 Jan 2024, 16:48 Peter Heywood, ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In include/flamegpu/util/cleanup.h
<#1169 (comment)>:
> @@ -1,8 +1,8 @@
#ifndef INCLUDE_FLAMEGPU_UTIL_CLEANUP_H_
#define INCLUDE_FLAMEGPU_UTIL_CLEANUP_H_
-/**
its a file level multline comment, not a docstring about a particular
namespace nor class (there isn't a cleanup specific namespace or class,
just method(s)
—
Reply to this email directly, view it on GitHub
<#1169 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAFVGCRWYEPDVSZIGKJASMDYNAVFZAVCNFSM6AAAAABBNDWWN6VHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMYTQMBWGM4DENBUHE>
.
You are receiving this because your review was requested.Message ID:
***@***.***>
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Replaces docstring comments with regular multline comments where appropriate (
/**->/*)Moves docstring comments to be correctly associated with the namespace where appropriate.
Adds a single explicit docstring comment for
flamegpu, inflamegpu/flamegpu.hCloses #1149