• Add Index Page
  • Add Index Page

    Update directory structure.

    1. If your project root directory is not already your current workig directory, make sure it is.
      cd example-project
    2. Create a directory for the documentation itself
      mkdir doc
      cd doc
      mkdir manual

    Add *.qdoc file

    Create the qdoc file doc/manual/landing-page.qdoc

    /*! \page index.html
    
    \title Welcome
    
    Welcome to this simple minimalistic example.
    
    \generatelist classes
    */

    Note that the title will be normally used as part of the style. With one esception: If the filename is index.html, q jQuery script of doc-style is going to remove the title from the html page to make it more easy to customize the first page.