Uploaded image for project: 'Apache Guacamole - Contributions'
  1. Apache Guacamole - Contributions
  2. GUAC-1391 Release 0.9.9
  3. GUAC-1434

Documentation generation warnings from Doxygen

    XMLWordPrintable

    Details

    • Type: Defect
    • Status: Done
    • Priority: Trivial
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Documentation
    • Labels:
      None
    • Sprint:
      DEV 2015-12-18

      Description

      Doxygen warns of deprecated options and undocumented arguments:

      ...
      Warning: Tag `SYMBOL_CACHE_SIZE' at line 289 of file `Doxyfile' has become obsolete.
               To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
      Warning: Tag `SHOW_DIRECTORIES' at line 483 of file `Doxyfile' has become obsolete.
               To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
      Warning: Tag `HTML_ALIGN_MEMBERS' at line 815 of file `Doxyfile' has become obsolete.
               To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
      Warning: Tag `USE_INLINE_TREES' at line 984 of file `Doxyfile' has become obsolete.
               To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
      Warning: Tag `XML_SCHEMA' at line 1186 of file `Doxyfile' has become obsolete.
               To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
      Warning: Tag `XML_DTD' at line 1192 of file `Doxyfile' has become obsolete.
               To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
      Warning: doxygen no longer ships with the FreeSans font.
      You may want to clear or change DOT_FONTNAME.
      Otherwise you run the risk that the wrong font is being used for dot generated graphs.
      ...
      /home/mjumper/guacamole/guacamole-server/src/libguac/guacamole/audio.h:143: warning: The following parameters of guac_audio_stream_reset(guac_audio_stream *audio, guac_audio_encoder *encoder, int rate, int channels, int bps) are not documented:
        parameter 'audio'
        parameter 'rate'
        parameter 'channels'
        parameter 'bps'
      ...
      /home/mjumper/guacamole/guacamole-server/src/libguac/guacamole/protocol.h:126: warning: argument 'ap' of command @param is not found in the argument list of vguac_protocol_send_log(guac_socket *socket, const char *format, va_list args)
      /home/mjumper/guacamole/guacamole-server/src/libguac/guacamole/protocol.h:126: warning: The following parameters of vguac_protocol_send_log(guac_socket *socket, const char *format, va_list args) are not documented:
        parameter 'args'
      /home/mjumper/guacamole/guacamole-server/src/libguac/guacamole/protocol.h:612: warning: The following parameters of guac_protocol_send_img(guac_socket *socket, const guac_stream *stream, guac_composite_mode mode, const guac_layer *layer, const char *mimetype, int x, int y) are not documented:
        parameter 'mimetype'
      ...

      The undocumented parameters are very likely the result of changes in 0.9.9.

        Attachments

          Activity

            People

            Assignee:
            mike.jumper Michael Jumper
            Reporter:
            mike.jumper Michael Jumper
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved: