Changeset e78e2b0 in rtems-tools


Ignore:
Timestamp:
Jan 22, 2013, 11:08:09 AM (7 years ago)
Author:
Chris Johns <chrisj@…>
Branches:
4.10, 4.11, master
Children:
2bcaf0c
Parents:
32d5401
Message:

Documentation.

Location:
linkers
Files:
1 added
8 edited

Legend:

Unmodified
Added
Removed
  • linkers/rld-compression.h

    r32d5401 re78e2b0  
    8787       * @param data Write the decompressed data here.
    8888       * @param length The mount of data in bytes to read.
     89       * @return size_t The amount of data read.
    8990       */
    9091      size_t read (void* data, size_t length);
     
    9394       * Read the decompressed data writing it to the image.
    9495       *
    95        * @param output The output image.
     96       * @param output_ The output image.
    9697       * @param offset The output image offset to write from.
    9798       * @param length The mount of data in bytes to read.
     99       * @return size_t The amount of data read.
    98100       */
    99101      size_t read (files::image& output_, off_t offset, size_t length);
     
    102104       * Read the decompressed data writing it to the image.
    103105       *
    104        * @param output The output image.
     106       * @param output_ The output image.
    105107       * @param length The mount of data in bytes to read.
     108       * @return size_t The amount of data read.
    106109       */
    107110      size_t read (files::image& output_, size_t length);
     
    110113       * The amount of uncompressed data transferred.
    111114       *
    112        * @param return size_t The amount of data tranferred.
     115       * @return size_t The amount of data tranferred.
    113116       */
    114117      size_t transferred () const;
     
    117120       * The amount of compressed data transferred.
    118121       *
    119        * @param return size_t The amount of compressed data tranferred.
     122       * @return size_t The amount of compressed data tranferred.
    120123       */
    121124      size_t compressed () const;
     
    123126      /**
    124127       * The current offset in the stream.
     128       *
     129       * @return off_t The current uncompressed offset.
    125130       */
    126131      off_t offset () const;
  • linkers/rld-elf.h

    r32d5401 re78e2b0  
    5050       * Construct a relocation record.
    5151       *
     52       * @param sym The symbol the relocation references.
    5253       * @param offset The offset in the section the relocation applies to.
    5354       * @param info The relocation info.
     
    386387       * @param filesz The segment size in the file.
    387388       * @param memsz The segment size in memory.
     389       * @param align The segment alignment.
    388390       * @param vaddr The virtual address in memory.
    389391       * @param paddr The physical address if any.
     
    556558       * symbols are not loaded they are loaded.
    557559       *
    558        * @param filter_syms The filtered symbols found in the file. This is a
    559        *                    container of pointers.
     560       * @param filtered_syms The filtered symbols found in the file. This is a
     561       *                      container of pointers.
     562       * @param unresolved Return unresolved symbols.
    560563       * @param local Return local symbols.
    561564       * @param weak Return weak symbols.
    562565       * @param global Return global symbols.
    563        * @param unresolved Return unresolved symbols.
    564566       */
    565567      void get_symbols (rld::symbols::pointers& filtered_syms,
  • linkers/rld-files.h

    r32d5401 re78e2b0  
    274274       * Construct the image.
    275275       *
    276        * @param name The file path.
     276       * @param path The file path.
    277277       * @param is_object If true (default) the name is for an object file.
    278278       */
     
    713713       * sections are appended.
    714714       *
    715        * @param filter_secs The container of the matching sections.
     715       * @param filtered_secs The container of the matching sections.
    716716       * @param type The section type. Must match. If 0 matches any.
    717717       * @param flags_in The sections flags that must be set. This is a
     
    730730       * appended.
    731731       *
    732        * @param filter_secs The container of the matching sections.
     732       * @param filtered_secs The container of the matching sections.
    733733       * @param name The name of the section.
    734734       */
     
    866866       *
    867867       * @param symbols The symbol table to load.
    868        * @param local Include local symbols. The default is not to.
     868       * @param locals Include local symbols. The default does not include them.
    869869       */
    870870      void load_symbols (symbols::table& symbols, bool locals = false);
  • linkers/rld-outputter.h

    r32d5401 re78e2b0  
    104104     * @param cache The file cache for the link. Includes the object list
    105105     *              the user requested.
     106     * @param symbols The symbol table used to resolve the application.
    106107     */
    107108    void application (const std::string&        name,
  • linkers/rld-rap.h

    r32d5401 re78e2b0  
    7373     * @param app The application image to write too.
    7474     * @param init The application's initialisation entry point.
    75      * @param exit The application's finish entry point .
     75     * @param fini The application's finish entry point .
    7676     * @param objects The list of object files in the application.
    7777     * @param symbols The symbol table used to create the application.
  • linkers/rtems-utils.h

    r32d5401 re78e2b0  
    3434     *
    3535     * @param addr The address of the memory to display.
    36      * @param mem The actual memory to display. If 0 use addr.
    3736     * @param length The number of elements to display.
    3837     * @param size The size of the data element.
    3938     * @param real Use the real address based on addr.
    4039     * @param line_length Number of elements per line.
     40     * @param offset The printed offset.
    4141     */
    4242    void dump (const void* addr,
  • linkers/rtl-host.conf

    r32d5401 re78e2b0  
    503503SHOW_USED_FILES        = YES
    504504
    505 # If the sources in your project are distributed over multiple directories
    506 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
    507 # in the documentation. The default is NO.
    508 
    509 SHOW_DIRECTORIES       = NO
    510 
    511505# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
    512506# This will remove the Files entry from the Quick Index and from the
     
    868862
    869863HTML_TIMESTAMP         = YES
    870 
    871 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
    872 # files or namespaces will be aligned in HTML using tables. If set to
    873 # NO a bullet list will be used.
    874 
    875 HTML_ALIGN_MEMBERS     = YES
    876864
    877865# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
     
    962950# to the contents of the HTML help documentation and to the tree view.
    963951
    964 TOC_EXPAND             = NO
     952TOC_EXPAND             = YES
    965953
    966954# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
     
    10541042# Windows users are probably better off using the HTML help feature.
    10551043
    1056 GENERATE_TREEVIEW      = NO
    1057 
    1058 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
    1059 # and Class Hierarchy pages using a tree view instead of an ordered list.
    1060 
    1061 USE_INLINE_TREES       = NO
     1044GENERATE_TREEVIEW      = YES
    10621045
    10631046# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
  • linkers/wscript

    r32d5401 re78e2b0  
    6161    if bld.cmd == 'doxy':
    6262        bld(features = 'doxygen',
    63             doxyfile = 'rtl-host.conf',
    64             doxy_tar = 'rtl-host-docs.tar.bz2')
     63            doxyfile = 'rtl-host.conf')
    6564        return
    6665
Note: See TracChangeset for help on using the changeset viewer.