Results 1 to 2 of 2

Thread: Pure QML and qdoc

  1. 26th February 2015, 12:34 #1
    joshelmich
    joshelmich is offline Beginner
    Join Date
    Feb 2015
    Posts
    2
    Qt products
    Qt5 Qt/Embedded
    Platforms
    Unix/X11 Windows

    Default Pure QML and qdoc

    Hi,

    I have some problems with qdoc documentation generation. I have a digia made config file for qdoc (see down below)

    Other than that some qdoc comments like

    Qt Code: 
    1. /*!
    2. 	\qmltype flipButton
    3. 	\inqmlmodule Components
    4. 	\brief component that flips a button.
    5.  
    6. 	This example makes use of a state machine to illustrate the power of
    7. 	designed screens.
    8.  
    9.  
    10. 	\section1 Aliases
    11. 	Also it shows how to work with aliases.
    12. 	\code property alias text:flipperToggle.text
    13. 	\endcode
    14.  
    15. 	\sa SimpleFlipper
    16.  
    17.  */
    To copy to clipboard, switch view to plain text mode 

    I like to provide some info about the qmlmodule "Components". I have added a comment to myApp.qml like this

    Qt Code: 
    1. /*!
    2. 	\qmlmodule Components	
    3. 	\brief This module has some example components that flip a button on a click. 
    4.  
    5. 	We explain more about this here.
    6.  
    7. */
    To copy to clipboard, switch view to plain text mode 

    Still I get warnings like this. Why is my comment for "Components" ignored? Why a warning about 'global' ?

    Beside of that in the part "List of all members, including inherited members" there seem to be no inherited members? Why is that?

    Qt Code: 
    1. qdoc: warning: No documentation for 'Components'
    2. qdoc: warning: No documentation for 'global'
    To copy to clipboard, switch view to plain text mode 


    Qt Code: 
    1. # Documentation configuration.
    2.  
    3.  
    4.  
    5. project                 = myApp
    6.  
    7. description             = Uxp Application
    8.  
    9. url                     = http://qt-project.org/
    10.  
    11. version                 = 0.0
    12.  
    13.  
    14.  
    15. qhp.projects            = myApp
    16.  
    17.  
    18.  
    19. qhp.myApp.file          = myApp.qhp
    20.  
    21. qhp.myApp.namespace     = myApp
    22.  
    23. qhp.myApp.virtualFolder = myApp
    24.  
    25. qhp.myApp.indexTitle    = myApp
    26.  
    27. qhp.myApp.indexRoot     =
    28.  
    29. qhp.extraFiles += style/online.css
    30.  
    31.  
    32.  
    33. sourcedirs += . \
    34.  
    35.               opt/Uxp/Applications/myApp/Components \
    36.  
    37.               opt/Uxp/Applications/myApp/Pages
    38.  
    39.  
    40. sources.fileextensions += *.qml
    41.  
    42.  
    43.  
    44. imagedirs += opt/Uxp/Applications/myApp/Pictures
    45.  
    46.  
    47.  
    48. outputdir = doc
    49.  
    50.  
    51.  
    52. HTML.headerstyles = \
    53.  
    54.     "  <link rel=\"stylesheet\" type=\"text/css\" href=\"style/online.css\" />\n"
    55.  
    56.  
    57.  
    58. HTML.endheader = \
    59.  
    60.     "</head>\n"
    61.  
    62.  
    63.  
    64. HTML.postheader = \
    65.  
    66.     "<body>\n" \
    67.  
    68.     "<div class=\"header\" id=\"qtdocheader\"></div>\n" \
    69.  
    70.     "    <div class=\"nav\" id=\"qt13a-header\">\n" \
    71.  
    72.     "        <div class=\"qt13a-gradient\">\n" \
    73.  
    74.     "        <div class=\"qt13a-container qt13a-dynamicREMOVE\" >\n" \
    75.  
    76.     "                <div id=\"qt13a-register\">\n" \
    77.  
    78.     "                    <a href=\"http://qt-project.org/\">Qt Home</a>\n" \
    79.  
    80.     "                    <a href=\"https://bugreports.qt-project.org/\">Bug Tracker</a>\n" \
    81.  
    82.     "                    <a href=\"https://codereview.qt-project.org/\">Code Review</a>\n" \
    83.  
    84.     "                </div>\n" \
    85.  
    86.     "                <div class=\"qt13a-sixCol\">\n" \
    87.  
    88.     "                    <div id=\"qt13a-title_nav\">\n" \
    89.  
    90.     "                        <div id=\"qt13a-title\">\n" \
    91.  
    92.     "                                <p class=\"qt13a-title\">myApp documentation</p>\n" \
    93.  
    94.     "                        </div>\n" \
    95.  
    96.     "                    </div>\n" \
    97.  
    98.     "                </div>\n" \
    99.  
    100.     "        </div>\n" \
    101.  
    102.     "        </div>\n" \
    103.  
    104.     "    </div>\n" \
    105.  
    106.     "    <div class=\"main\">\n" \
    107.  
    108.     "    <div class=\"main-rounded\">\n" \
    109.  
    110.     "        <div class=\"navigationbar\">\n" \
    111.  
    112.     "            <ul>\n" \
    113.  
    114.  
    115.  
    116. HTML.postpostheader = \
    117.  
    118.     "            </ul>\n" \
    119.  
    120.     "        </div>\n" \
    121.  
    122.     "<div class=\"content\">\n" \
    123.  
    124.     "    <div class=\"line\">\n" \
    125.  
    126.     "        <div class=\"content mainContent\">\n" \
    127.  
    128.  
    129.  
    130. HTML.stylesheets = online.css
    To copy to clipboard, switch view to plain text mode 
    Reply With Quote Reply With Quote
  2. 27th February 2015, 16:26 #2
    joshelmich
    joshelmich is offline Beginner
    Join Date
    Feb 2015
    Posts
    2
    Qt products
    Qt5 Qt/Embedded
    Platforms
    Unix/X11 Windows

    Default Re: Pure QML and qdoc

    I finally figured out why the warnings came. Groups (and maybe qmodules) have to be defined in a seperate file with qdoc extension, like

    group1.qdoc
    Qt Code: 
    1. /*!
    2. \group group1
    3. \brief Brief description
    4.  
    5. Full description
    6.  
    7. */
    To copy to clipboard, switch view to plain text mode 

    Putting this in a qml-file will not work. It will just be ignored. Thats not all. Files need to be defined in the config. In this case add
    Qt Code: 
    1. sources.fileextensions += *.qdocs
    To copy to clipboard, switch view to plain text mode 
    Reply With Quote Reply With Quote
« Previous Thread | Next Thread »

Similar Threads

  1. qdoc problem
    By codeman in forum Qt Tools
    Replies: 13
    Last Post: 20th January 2015, 16:04
  2. Qt assistant qdoc how to generate application help
    By salcin in forum Qt Programming
    Replies: 0
    Last Post: 11th February 2014, 16:49
  3. A VERY VERY WEIRD pure c++ problem
    By Zander87 in forum General Programming
    Replies: 1
    Last Post: 27th November 2012, 23:27
  4. Using Qt Creator as a pure C IDE?
    By blooglet in forum Qt Tools
    Replies: 3
    Last Post: 11th November 2011, 01:21
  5. the memory is not pure
    By mickey in forum General Programming
    Replies: 3
    Last Post: 14th July 2007, 17:10

Bookmarks

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •  

Forum Rules

Digia, Qt and their respective logos are trademarks of Digia Plc in Finland and/or other countries worldwide.