Skip to content

Conversation

@sblondon
Copy link
Contributor

Doxygen displays two warnings (among others) because parameters filled in @params are not correct.

The warnings fixed are:

pspsdk/src/user/pspthreadman.h:622: warning: argument 'optionsPTr' of command @param is not found in the argument list of sceKernelCreateLwMutex(SceLwMutexWorkarea *workarea, const char *name, SceUInt32 attr, int initialCount, u32 *optionsPtr) pspsdk/src/user/pspthreadman.h:622: warning: The following parameter of sceKernelCreateLwMutex(SceLwMutexWorkarea *workarea, const char *name, SceUInt32 attr, int initialCount, u32 *optionsPtr) is not documented:
  parameter 'optionsPtr'
pspsdk/src/user/pspthreadman.h:665: warning: argument 'name' of command @param is not found in the argument list of sceKernelUnlockLwMutex(SceLwMutexWorkarea *workarea, int lockCount)

There is another type of warning about the source code documentation like:

pspsdk/src/prof/pspprof.h:28: warning: argument 'filename' of command @param is not found in the argument list of __attribute__((__no_instrument_function__, __no_profile_instrument_function__))
pspsdk/src/prof/pspprof.h:28: warning: argument 'should_dump' of command @param is not found in the argument list of __attribute__((__no_instrument_function__, __no_profile_instrument_function__))
/

There is the same case for prof.c:278.

The issue is the __attribute__() before the function definition. Moving the __attribute__() line above the comments does not solve the issue. So I did not fixed them.

Do you have any idea how to fix them?

Doxygen displays two warnings (among others) because parameters filled in @params are not correct.

The warnings fixed are:
pspsdk/src/user/pspthreadman.h:622: warning: argument 'optionsPTr' of command @param is not found in the argument list of sceKernelCreateLwMutex(SceLwMutexWorkarea *workarea, const char *name, SceUInt32 attr, int initialCount, u32 *optionsPtr)
pspsdk/src/user/pspthreadman.h:622: warning: The following parameter of sceKernelCreateLwMutex(SceLwMutexWorkarea *workarea, const char *name, SceUInt32 attr, int initialCount, u32 *optionsPtr) is not documented:
  parameter 'optionsPtr'
pspsdk/src/user/pspthreadman.h:665: warning: argument 'name' of command @param is not found in the argument list of sceKernelUnlockLwMutex(SceLwMutexWorkarea *workarea, int lockCount)
@diamant3
Copy link
Member

Do you have any idea how to fix them?

You could explicitly state the function @fn: https://www.doxygen.nl/manual/commands.html#cmdfn

Copy link
Member

@sharkwouter sharkwouter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! This is a nice little fix. Should I merge it like this or would you want to try to add fixes for the other warnings to this one?

@sblondon
Copy link
Contributor Author

@diamant3 thanks for the link, I will work on it.

@sharkwouter @fn could raise new questions, so I think it's better to merge the current PR. I will write an other PR, linked to this one.

@sharkwouter sharkwouter merged commit 3826a1e into pspdev:master Mar 30, 2025
1 check passed
@sblondon sblondon deleted the fix-2-warnings branch March 30, 2025 10:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants