Code documentation (Doxygen)

If you are working at a huge software project it’s important to always write a documentation. This is important cause other programmers who use your code have to understand how it’s working. A good possibility is to use a tool which generates a code documentaion based on special comments written in the source. There are a view possibilities to choose from, e.g. Javadoc or Doxygen. In the current project at work we are using Doxygen. It’s getting used for documenting classes, functions and even variables.

struct Path;
struct Items;

/**
 * @brief The browser is used to browse a filesystem
 */
class Browser {
public:
   /// Creates a browser with a maximum path length
   Browser(const size_t maxPath);

   /**
    * @brief Browse the items of a path
    *
    * @param[in] path - the path to browse
    * @param[out] items - the browsed items
    *
    * @return true if path exists, else false
    */
   bool browse(Path& path, Items& items);

private:
   const size_t m_MaxPath; ///< The maximum path length
};