[DNM] DOXYGEN: doxygen changes in header files 2

[b-gent]

Edited files in the common folder:

• bufferedstream.h
• callback.h
• config-manager.h
• coroutines.h
• cosinetables.h
• dcl.h
• debug.h
• debug-channels.h

Output is available on https://b-gent.github.io/PR2488/group__common__buffstream.html

[b-gent]

Summary of work needed for these header files:

bufferedstream.h (low priority)

Well-documented

callback.h (low priority)

I don't fully get these callbacks, I added some descriptions (please check) but the following are still missing:

• GlobalFunctionCallback(GlobalFunction cb) (line 70)
• Callback(T *object, TMethod method) (line 99)
• CallbackBridge(T *object, TCallbackMethod method, BaseCallback *outerCallback) (line 141)

config-manager.h (high priority)

• bool hasKey(const String &key) const; -> not sure how to define this 'key' and thus don't know how to document the structures that use it as an argument
  const String & get(const String &key) const;
  void set(const String &key, const String &value); (lines 129-131)

• bool hasKey(const String &key, const String &domName) const;
  const String & get(const String &key, const String &domName) const;
  void set(const String &key, const String &value, const String &domName);
  void removeKey(const String &key, const String &domName); (lines 151-155)

• void registerDefault(const String &key, const String &value);
  void registerDefault(const String &key, const char *value);
  void registerDefault(const String &key, int value);
  void registerDefault(const String &key, bool value); (lines 170-173)

• bool hasGameDomain(const String &domName) const;
  bool hasMiscDomain(const String &domName) const; (lines 190-191)

• DomainMap::iterator beginGameDomains() { return _gameDomains.begin();
  DomainMap::iterator endGameDomains() { return _gameDomains.end(); (lines 194-195)

• void copyFrom(ConfigManager &source); (line 198)

• ALL members of the Domain class are undocumented (lines 66-91):
  const_iterator begin() const { return _entries.begin(); }
  const_iterator end() const { return _entries.end(); }

    bool empty() const { return _entries.empty(); }
  
    bool contains(const String &key) const { return _entries.contains(key); }
  
    String &operator[](const String &key) { return _entries[key]; }
    const String &operator[](const String &key) const { return _entries[key]; }
  
    void setVal(const String &key, const String &value) { _entries.setVal(key, value); }
  
    String &getVal(const String &key) { return _entries.getVal(key); }
    const String &getVal(const String &key) const { return _entries.getVal(key); }
  
    void clear() { _entries.clear(); }
  
    void erase(const String &key) { _entries.erase(key); }
  
    void setDomainComment(const String &comment);
    const String &getDomainComment() const;
  
    void setKVComment(const String &key, const String &comment);
    const String &getKVComment(const String &key) const;
    bool hasKVComment(const String &key) const;
  

  };

courutines.h (low priority)

Overall quite well documented, especially for a low-priority header.

cosinetables.h (low priority)

Overall quite well documented, especially for a low-priority header.

dcl.h (low priority)

Well-documented

debug.h (high priority)

Well-documented

debug-channels.h (med priority)

Functions well-documented.

[sev-]

This needs rebase now.

[b-gent]

This needs rebase now.

Rebased.

[sev-]

Good progress, merging.

[sev-]

That broke the compilation horribly, for obvious reasons.

[b-gent]

To be honest, I was assuming we would still be working on this PR, at least adding missing doc in the high-priority headers. Hence the 'Do Not Merge' label in its title.