search

FLAMEGPU / FLAMEGPU2

FLAME GPU 2 is a GPU accelerated agent based modelling framework for CUDA C++ and Python
https://flamegpu.com
MIT License
99 stars 19 forks source link

Fix docstring(s) attributed to the flamegpu namespace #1169

Closed ptheywood closed 5 months ago

ptheywood commented 6 months ago

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, in flamegpu/flamegpu.h

Closes #1149

ptheywood commented 6 months ago

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 commented 6 months ago

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 https://github.com/FLAMEGPU/FLAMEGPU2/pull/1169#discussion_r1443112075:

@@ -1,8 +1,8 @@

ifndef INCLUDE_FLAMEGPU_UTIL_CLEANUPH

define INCLUDE_FLAMEGPU_UTIL_CLEANUPH

-/**

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 https://github.com/FLAMEGPU/FLAMEGPU2/pull/1169#discussion_r1443112075, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAFVGCRWYEPDVSZIGKJASMDYNAVFZAVCNFSM6AAAAABBNDWWN6VHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMYTQMBWGM4DENBUHE . You are receiving this because your review was requested.Message ID: @.***>