docs/naturaldocs/Menu.txt

   1 Format: 1.4
   2
   3
   4 Title: ALURE
   5 SubTitle: API Reference
   6
   7 # You can add a footer to your documentation like this:
   8 # Footer: [text]
   9 # If you want to add a copyright notice, this would be the place to do it.
  10
  11 # You can add a timestamp to your documentation like one of these:
  12 # Timestamp: Generated on month day, year
  13 # Timestamp: Updated mm/dd/yyyy
  14 # Timestamp: Last updated mon day
  15 #
  16 #   m     - One or two digit month.  January is "1"
  17 #   mm    - Always two digit month.  January is "01"
  18 #   mon   - Short month word.  January is "Jan"
  19 #   month - Long month word.  January is "January"
  20 #   d     - One or two digit day.  1 is "1"
  21 #   dd    - Always two digit day.  1 is "01"
  22 #   day   - Day with letter extension.  1 is "1st"
  23 #   yy    - Two digit year.  2006 is "06"
  24 #   yyyy  - Four digit year.  2006 is "2006"
  25 #   year  - Four digit year.  2006 is "2006"
  26
  27
  28 # --------------------------------------------------------------------------
  29 #
  30 # Cut and paste the lines below to change the order in which your files
  31 # appear on the menu.  Don't worry about adding or removing files, Natural
  32 # Docs will take care of that.
  33 #
  34 # You can further organize the menu by grouping the entries.  Add a
  35 # "Group: [name] {" line to start a group, and add a "}" to end it.
  36 #
  37 # You can add text and web links to the menu by adding "Text: [text]" and
  38 # "Link: [name] ([URL])" lines, respectively.
  39 #
  40 # The formatting and comments are auto-generated, so don't worry about
  41 # neatness when editing the file.  Natural Docs will clean it up the next
  42 # time it is run.  When working with groups, just deal with the braces and
  43 # forget about the indentation and comments.
  44 #
  45 # --------------------------------------------------------------------------
  46
  47
  48 File: Main and Miscellanious  (no auto-title, alure.cpp)
  49 File: File Loading  (no auto-title, buffer.cpp)
  50 File: Streaming  (no auto-title, stream.cpp)
  51 File: File I/O  (istream.cpp)
  52 File: Automatic Playback  (streamplay.cpp)
  53
  54 Group: Index  {
  55
  56    Index: Everything
  57    Function Index: Functions
  58    }  # Group: Index
  59