Changeset 37


Ignore:
Timestamp:
02/23/12 21:42:54 (6 years ago)
Author:
shan2
Message:

ForSyDe-SystemC: added main page documentation for doxygen.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • ForSyDe-SystemC/trunk/src/forsyde.hpp

    r26 r37  
    1515#ifndef FORSYDE_HPP 
    1616#define FORSYDE_HPP 
     17 
     18/*! \mainpage ForSyDe-SystemC API Documentation 
     19 * 
     20 * \section intro_sec Introduction 
     21 * 
     22 * This documentation is supplied as the API-level guideline for using the 
     23 * ForSyDe-SystemC library. 
     24 * It is generated automatically from the library source code and is updated 
     25 * with the library itself. 
     26 * 
     27 * \subsection scope_purpose Scope and Purpose 
     28 * 
     29 * This document provides the designer with information about the constructs 
     30 * provided by the library and how they can be used practically. 
     31 * It does NOT describe the general modeling concepts and formalisms behind 
     32 * ForSyDe. 
     33 * 
     34 * It is suggested to consult the ForSyDe webpage and Wiki page before starting 
     35 * modeling with this library. 
     36 * More information and tutorials are available there. 
     37 * 
     38 * \section using_doc Using the Documentation 
     39 * 
     40 * ForSyDe-SystemC library mainly includes constructs to build processes in 
     41 * different Models of Computation (MoCs) and connect them using domain 
     42 * interfaces. 
     43 * 
     44 * \subsection namespaces_mocs Namespaces and MoCs 
     45 * 
     46 * Everything provided by the ForSyDe-SystemC library is a member of the 
     47 * ForSyDe namespace. 
     48 * In addition, there is a separate sub-namespace dedicated to each MoC which 
     49 * includes process constructors and other constructs related to that specific 
     50 * MoC. 
     51 * Originally, 4 different MoCs are suported in ForSyDe-SystemC: 
     52 * 
     53 *     - Synchronous MoC in ForSyDe::SY 
     54 *     - Untimed MoC (only the Synchronous Dataflow variant) in ForSyDe::SDF 
     55 *     - Discrete-Event MoC in ForSyDe::DE 
     56 *     - Continuous-Time MoC in ForSyDe::CT 
     57 */ 
    1758 
    1859/*! \file forsyde.h 
Note: See TracChangeset for help on using the changeset viewer.