Skip to content
  • Categories
  • Recent
  • Tags
  • Popular
  • Users
  • Groups
  • Search
  • Get Qt Extensions
  • Unsolved
Collapse
Brand Logo
  1. Home
  2. Qt Development
  3. General and Desktop
  4. Custom Qt Doxygen Dokumentation
Forum Updated to NodeBB v4.3 + New Features

Custom Qt Doxygen Dokumentation

Scheduled Pinned Locked Moved Unsolved General and Desktop
4 Posts 3 Posters 1.1k Views 2 Watching
  • Oldest to Newest
  • Newest to Oldest
  • Most Votes
Reply
  • Reply as topic
Log in to reply
This topic has been deleted. Only users with topic management privileges can see it.
  • Lennart62L Offline
    Lennart62L Offline
    Lennart62
    wrote on last edited by
    #1

    Hey,
    is there a way to modify the dokumentation style of doxygen in Qt in a .ini/template/xml file?

    For example I do not want to comment a function like this (doxygen-style):
    /**
    * @brief addOne
    * @param value
    * @return
    */
    int addOne(int value);

    I want to comment the function in this way:
    /%&
    # @brief addOne
    # @param value
    # @return
    %&/
    int addOne(int value);

    So is there a way to change the documentation style in an easy way?

    Best Regards

    JohanSoloJ 1 Reply Last reply
    0
    • mrjjM Offline
      mrjjM Offline
      mrjj
      Lifetime Qt Champion
      wrote on last edited by mrjj
      #2

      Hi and welcome
      If you mean like custom Comment blocks, i have never seen a way to change it
      as it would be complex to handle for the parser.

      So as far as I know it supports these
      http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html

      Also, for

      /%&
      # @brief addOne
      # @param value
      # @return
      %&/
      

      Dont it give you compiler errors ?

      1 Reply Last reply
      0
      • Lennart62L Offline
        Lennart62L Offline
        Lennart62
        wrote on last edited by
        #3

        Hey mrjj,

        thanks for response.

        I've found: In the doxygensettingsstruct an Enum called:
        enum DoxygenStyle {
        javaDoc = 0,
        qtDoc = 1,
        customDoc = 2
        };
        according to: https://github.com/fpoussin/qtcreator-doxygen/blob/master/doxygensettingsstruct.h
        so I thought I can set an user custom made doxy documentation.

        Maybe I have to recompile the Creators doxygen plugin with some settings?

        1 Reply Last reply
        0
        • Lennart62L Lennart62

          Hey,
          is there a way to modify the dokumentation style of doxygen in Qt in a .ini/template/xml file?

          For example I do not want to comment a function like this (doxygen-style):
          /**
          * @brief addOne
          * @param value
          * @return
          */
          int addOne(int value);

          I want to comment the function in this way:
          /%&
          # @brief addOne
          # @param value
          # @return
          %&/
          int addOne(int value);

          So is there a way to change the documentation style in an easy way?

          Best Regards

          JohanSoloJ Offline
          JohanSoloJ Offline
          JohanSolo
          wrote on last edited by
          #4

          @Lennart62 said

          I want to comment the function in this way:
          /%&
          # @brief addOne
          # @param value
          # @return
          %&/
          int addOne(int value);

          I have to agree with @mrjj : how can your compiler understand this is a comment? Doxygen might be able to extract it (as it supports many languages), but you won't be able to tell your C / C++ compiler to ignore those lines.

          `They did not know it was impossible, so they did it.'
          -- Mark Twain

          1 Reply Last reply
          0

          • Login

          • Login or register to search.
          • First post
            Last post
          0
          • Categories
          • Recent
          • Tags
          • Popular
          • Users
          • Groups
          • Search
          • Get Qt Extensions
          • Unsolved