githubmirror/libsmbios

doc/coding/index.txt
59 строк2 KB
Michael E Brown
initial import from clearcase
16 май 2007, 00:00
16 май 2007, 00:00547a4d4

/** \page coding Documentation, Coding Standards, Style and Automated Reports

 \section docs Design Overview
 \li \ref overview_overview
 \li \ref presentation
 \li \ref unit_test_theory 
 \li \ref smbios_theory
 \li \ref item_theory
 \li \ref workaround_theory
 \li \ref factory_theory *
 \li \ref memory_theory *
 \li \ref cmos_theory *
 \li \ref security

 \section style Coding Standards, Style, and Patch Submission
 \li \ref compilation
 \li \ref api_abi *
 \li \ref header_rules
 \li \ref coding_style
 \li \ref patches 

 \section auto Automated Reports
 \li \ref code_coverage 
 \li \ref leak_detect 

 \note --*-- These pages are still in progress.

 \section start Where to start

 For developers wishing to start out using the libsmbios library, please start
 at the following doxygen pages: 
   - C-API information: SystemInfo.h
   - SMBIOS C++ API information: smbios::SmbiosFactory, smbios::ISmbiosTable,
     smbios::ISmbiosItem 
   - CMOSTOKEN C++ API information: smbios::CmosTokenTableFactory,
     smbios::ICmosTokenTable, smbios::ICmosToken

 \section add Adding new documentation

 The libsmbios project uses Doxygen for all project documentation. The text for
 this page is in doc/mainpage.txt in the source tree. All additional
 documentation linked by this page is available in doc/*.txt files. Be aware
 that some of these text files are automatically generated, such as the code
 coverage report.

 All class diagram and stuff behind the links at the top of this page are
 automatically generated by Doxygen from the source code. Each page says which
 source files were used. Look for text like this at the bottom of each page:

\verbatim
 The documentation for this class was generated from the following files:
    - SomeFile.h
    - AnotherFile.h
    - SomeFile.cpp
        ... 
\endverbatim


 */