Documentation - apply the module group to the corresponding module for doxygen.

[oopsmonk]

trafficstars

This epic lists module without group tag in the header files. For showing modules correctly on the webpage, need to apply the module group to all header files. For instance, here is the folder structure of CClicent module, it contains header files and a doxy.txt file in the cclient/api/core.

cclient                          
├── api                      
│   ├── core               
│   │   ├── add_neighbors.h   
│   │   ├── attach_to_tangle.h      
│   │   ├── broadcast_transactions.h
│   │   ├── check_consistency.h
│   │   ├── core_api.h
│   │   ├── core_init.h        
│   │   ├── doxy.txt      
│   │   ├── find_transactions.h   
│   │   ├── get_balances.h            
│   │   ├── get_inclusion_states.h
│   │   ├── get_neighbors.h
│   │   ├── get_node_info.h
│   │   ├── get_tips.h                   
│   │   ├── get_transactions_to_approve.h
│   │   ├── get_trytes.h             
│   │   ├── logger.h         
│   │   ├── remove_neighbors.h
│   │   └── store_transactions.h

The doxy.txt describes module information and has a specific group cclient_core ref: https://github.com/iotaledger/entangled/blob/develop/cclient/api/core/doxy.txt#L9

 /**
 * @defgroup cclient_core CClient Core API
 * @ingroup cclient
 * @brief CClient Core API implementations

What needs to do is to apply the cclient_core group to all header files that belong to CClient Core API module. Wrapping the header file up with cclient_core group:

/**
 * @ingroup cclient_core
 *
 * @{
 *
 * @file
 * @brief
 *
 */

and

/** @} */

ref: https://github.com/iotaledger/entangled/blob/develop/cclient/api/core/add_neighbors.h#L8

[thibault-martinez]

I don't think empty

 * @file
 * @brief

are necessary, let's only put them if we fill them. Looking at Doxygen documentation, only @ingroup is really necessary.

[oopsmonk]

I don't think empty

 * @file
 * @brief

are necessary, let's only put them if we fill them. Looking at Doxygen documentation, only @ingroup is really necessary.

The empty fields keep webpage simple and easy to maintain contents in the individual classes(files in our case) in modules.

[thibault-martinez]

My tests concluded that @file is necessary and @brief isn't. I highly recommend filling @brief or not putting it.

[oopsmonk]

It's a template and @brief is optional, I prefer to keep it blank for some ppl don't familiar with doxgen. it's not a big deal If you know what you do.

[thibault-martinez]

Thanks for the clarification !