Documentation.

Author: kiwichris

main-page.cpp

@@ -86,42 +86,47 @@ namespace rld
        *
        * @param data Write the decompressed data here.
        * @param length The mount of data in bytes to read.
+       * @return size_t The amount of data read.
        */
       size_t read (void* data, size_t length);
 
       /**
        * Read the decompressed data writing it to the image.
        *
-       * @param output The output image.
+       * @param output_ The output image.
        * @param offset The output image offset to write from.
        * @param length The mount of data in bytes to read.
+       * @return size_t The amount of data read.
        */
       size_t read (files::image& output_, off_t offset, size_t length);
 
       /**
        * Read the decompressed data writing it to the image.
        *
-       * @param output The output image.
+       * @param output_ The output image.
        * @param length The mount of data in bytes to read.
+       * @return size_t The amount of data read.
        */
       size_t read (files::image& output_, size_t length);
 
       /**
        * The amount of uncompressed data transferred.
        *
-       * @param return size_t The amount of data tranferred.
+       * @return size_t The amount of data tranferred.
        */
       size_t transferred () const;
 
       /**
        * The amount of compressed data transferred.
        *
-       * @param return size_t The amount of compressed data tranferred.
+       * @return size_t The amount of compressed data tranferred.
        */
       size_t compressed () const;
 
       /**
        * The current offset in the stream.
+       *
+       * @return off_t The current uncompressed offset.
        */
       off_t offset () const;
 

rld-compression.h

@@ -49,6 +49,7 @@ namespace rld
       /**
        * Construct a relocation record.
        *
+       * @param sym The symbol the relocation references.
        * @param offset The offset in the section the relocation applies to.
        * @param info The relocation info.
        * @param addend The constant addend value.
@@ -385,6 +386,7 @@ namespace rld
        * @param offset The offet to segment.
        * @param filesz The segment size in the file.
        * @param memsz The segment size in memory.
+       * @param align The segment alignment.
        * @param vaddr The virtual address in memory.
        * @param paddr The physical address if any.
        */
@@ -555,12 +557,12 @@ namespace rld
        * Get a filtered container of symbols given the various types. If the
        * symbols are not loaded they are loaded.
        *
-       * @param filter_syms The filtered symbols found in the file. This is a
-       *                    container of pointers.
+       * @param filtered_syms The filtered symbols found in the file. This is a
+       *                      container of pointers.
+       * @param unresolved Return unresolved symbols.
        * @param local Return local symbols.
        * @param weak Return weak symbols.
        * @param global Return global symbols.
-       * @param unresolved Return unresolved symbols.
        */
       void get_symbols (rld::symbols::pointers& filtered_syms,
                         bool                    unresolved = false,

rld-elf.h

@@ -273,7 +273,7 @@ namespace rld
       /**
        * Construct the image.
        *
-       * @param name The file path.
+       * @param path The file path.
        * @param is_object If true (default) the name is for an object file.
        */
       image (const std::string& path, bool is_object = true);
@@ -712,7 +712,7 @@ namespace rld
        * flags. The filtered section container is not cleared so any matching
        * sections are appended.
        *
-       * @param filter_secs The container of the matching sections.
+       * @param filtered_secs The container of the matching sections.
        * @param type The section type. Must match. If 0 matches any.
        * @param flags_in The sections flags that must be set. This is a
        *                 mask. If 0 matches any.
@@ -729,7 +729,7 @@ namespace rld
        * filtered section container is not cleared so any matching sections are
        * appended.
        *
-       * @param filter_secs The container of the matching sections.
+       * @param filtered_secs The container of the matching sections.
        * @param name The name of the section.
        */
       void get_sections (sections& filtered_secs, const std::string& name);
@@ -865,7 +865,7 @@ namespace rld
        * Load the symbols into the symbol table.
        *
        * @param symbols The symbol table to load.
-       * @param local Include local symbols. The default is not to.
+       * @param locals Include local symbols. The default does not include them.
        */
       void load_symbols (symbols::table& symbols, bool locals = false);
 

rld-files.h

@@ -103,6 +103,7 @@ namespace rld
      * @param dependents The list of dependent object files
      * @param cache The file cache for the link. Includes the object list
      *              the user requested.
+     * @param symbols The symbol table used to resolve the application.
      */
     void application (const std::string&        name,
                       const std::string&        entry,

rld-outputter.h

@@ -72,7 +72,7 @@ namespace rld
      *
      * @param app The application image to write too.
      * @param init The application's initialisation entry point.
-     * @param exit The application's finish entry point .
+     * @param fini The application's finish entry point .
      * @param objects The list of object files in the application.
      * @param symbols The symbol table used to create the application.
      */

rld-rap.h

@@ -33,11 +33,11 @@ namespace rtems
      * Hex display memory.
      *
      * @param addr The address of the memory to display.
-     * @param mem The actual memory to display. If 0 use addr.
      * @param length The number of elements to display.
      * @param size The size of the data element.
      * @param real Use the real address based on addr.
      * @param line_length Number of elements per line.
+     * @param offset The printed offset.
      */
     void dump (const void* addr,
                size_t      length,

rtems-utils.h

@@ -502,12 +502,6 @@ MAX_INITIALIZER_LINES  = 30
 
 SHOW_USED_FILES        = YES
 
-# If the sources in your project are distributed over multiple directories
-# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
-# in the documentation. The default is NO.
-
-SHOW_DIRECTORIES       = NO
-
 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
 # This will remove the Files entry from the Quick Index and from the
 # Folder Tree View (if specified). The default is YES.
@@ -868,12 +862,6 @@ HTML_COLORSTYLE_GAMMA  = 80
 
 HTML_TIMESTAMP         = YES
 
-# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
-# files or namespaces will be aligned in HTML using tables. If set to
-# NO a bullet list will be used.
-
-HTML_ALIGN_MEMBERS     = YES
-
 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
 # documentation will contain sections that can be hidden and shown after the
 # page has loaded. For this to work a browser that supports
@@ -961,7 +949,7 @@ BINARY_TOC             = NO
 # The TOC_EXPAND flag can be set to YES to add extra items for group members
 # to the contents of the HTML help documentation and to the tree view.
 
-TOC_EXPAND             = NO
+TOC_EXPAND             = YES
 
 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
@@ -1053,12 +1041,7 @@ ENUM_VALUES_PER_LINE   = 4
 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
 # Windows users are probably better off using the HTML help feature.
 
-GENERATE_TREEVIEW      = NO
-
-# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
-# and Class Hierarchy pages using a tree view instead of an ordered list.
-
-USE_INLINE_TREES       = NO
+GENERATE_TREEVIEW      = YES
 
 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
 # used to set the initial width (in pixels) of the frame in which the tree

rtl-host.conf

@@ -60,8 +60,7 @@ def build(bld):
     #
     if bld.cmd == 'doxy':
         bld(features = 'doxygen',
-            doxyfile = 'rtl-host.conf',
-            doxy_tar = 'rtl-host-docs.tar.bz2')
+            doxyfile = 'rtl-host.conf')
         return
 
     if bld.env.SHOW_COMMANDS == 'yes':