Doc suggestion: Add module of the class

Hi,

currently I find myself often doing

grep -R ClassName juce/modules

to find out the module I have to add to my project to use a particular class. AFAIK you’re using Doxygen for the documentaion. maybe you could use

/// @defgroup juce_audio_utils Classes for audio-related GUI and miscellaneous tasks.
and
/// @ingroup juce_audio_utils

This adds a link to the group below the classname heading and also adds a modules section to the doxygen navigation.

Best,
Ben

3 Likes

I would really love if this were added to the documentation.

Also, I’ve written a script to find modules based on the classes you want to use.
Here is the link to that script.

Hasn’t this change already been made? The process_source_files.py script in the doxygen folder adds the @defgroup module_name comments, and the module name shows up under the class name in the doc pages.

Is there somewhere you expect to see the module name where it is not showing up?

1 Like

I appreciate your reply. It is exactly where you say it is.

It turns out that I sometimes cannot see things that are right in front of my face. I should probably get some sleep.