master/doxygen.c
branchstable-1.0
changeset 1619 0d4119024f55
parent 1618 5cff10efb927
equal deleted inserted replaced
1618:5cff10efb927 1619:0d4119024f55
     6  *
     6  *
     7  *  This file is part of the IgH EtherCAT Master.
     7  *  This file is part of the IgH EtherCAT Master.
     8  *
     8  *
     9  *  The IgH EtherCAT Master is free software; you can redistribute it
     9  *  The IgH EtherCAT Master is free software; you can redistribute it
    10  *  and/or modify it under the terms of the GNU General Public License
    10  *  and/or modify it under the terms of the GNU General Public License
    11  *  as published by the Free Software Foundation; version 2 of the License.
    11  *  as published by the Free Software Foundation; either version 2 of the
       
    12  *  License, or (at your option) any later version.
    12  *
    13  *
    13  *  The IgH EtherCAT Master is distributed in the hope that it will be
    14  *  The IgH EtherCAT Master is distributed in the hope that it will be
    14  *  useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
    15  *  useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
    15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    16  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    16  *  GNU General Public License for more details.
    17  *  GNU General Public License for more details.
    17  *
    18  *
    18  *  You should have received a copy of the GNU General Public License
    19  *  You should have received a copy of the GNU General Public License
    19  *  along with the IgH EtherCAT Master; if not, write to the Free Software
    20  *  along with the IgH EtherCAT Master; if not, write to the Free Software
    20  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
    21  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
    21  *
    22  *
       
    23  *  The right to use EtherCAT Technology is granted and comes free of
       
    24  *  charge under condition of compatibility of product made by
       
    25  *  Licensee. People intending to distribute/sell products based on the
       
    26  *  code, have to sign an agreement to guarantee that products using
       
    27  *  software based on IgH EtherCAT master stay compatible with the actual
       
    28  *  EtherCAT specification (which are released themselves as an open
       
    29  *  standard) as the (only) precondition to have the right to use EtherCAT
       
    30  *  Technology, IP and trade marks.
       
    31  *
    22  *****************************************************************************/
    32  *****************************************************************************/
    23 
    33 
    24 /**
    34 // This file only contains the doxygen mainpage.
    25    \file
       
    26    Just for the doxygen mainpage.
       
    27 */
       
    28 
    35 
    29 /*****************************************************************************/
    36 /*****************************************************************************/
    30 
    37 
    31 /**
    38 /**
    32    \mainpage The IgH EtherCAT master
    39    \mainpage The IgH EtherCAT master
    33 
    40 
    34    \section sec_docs Documentation
    41    \section sec_general General information
    35 
    42 
    36    You will find the code documentation in the modules section.
    43    This HTML contains the complete code documentation.
    37 
    44 
    38    There is an external API documentation for the realtime interface.
    45    The API documentations are in the <a href="modules.html">modules
       
    46    section</a>.
    39 
    47 
    40    For information how to build and install, see the README file.
    48    For information how to build and install, see the INSTALL file in the source
       
    49    root.
    41 
    50 
    42    \section sec_contact Contact
    51    \section sec_contact Contact
    43 
    52 
    44    \verbatim
    53    \verbatim
    45    Florian Pose <fp@igh-essen.com>
    54    Florian Pose <fp@igh-essen.com>
    56 
    65 
    57    This file is part of the IgH EtherCAT Master.
    66    This file is part of the IgH EtherCAT Master.
    58 
    67 
    59    The IgH EtherCAT Master is free software; you can redistribute it
    68    The IgH EtherCAT Master is free software; you can redistribute it
    60    and/or modify it under the terms of the GNU General Public License
    69    and/or modify it under the terms of the GNU General Public License
    61    as published by the Free Software Foundation; version 2 of the License.
    70    as published by the Free Software Foundation; either version 2 of the
       
    71    License, or (at your option) any later version.
    62 
    72 
    63    The IgH EtherCAT Master is distributed in the hope that it will be
    73    The IgH EtherCAT Master is distributed in the hope that it will be
    64    useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
    74    useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
    65    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    75    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    66    GNU General Public License for more details.
    76    GNU General Public License for more details.
    67 
    77 
    68    You should have received a copy of the GNU General Public License
    78    You should have received a copy of the GNU General Public License
    69    along with the IgH EtherCAT Master; if not, write to the Free Software
    79    along with the IgH EtherCAT Master; if not, write to the Free Software
    70    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
    80    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
       
    81 
       
    82    The right to use EtherCAT Technology is granted and comes free of
       
    83    charge under condition of compatibility of product made by
       
    84    Licensee. People intending to distribute/sell products based on the
       
    85    code, have to sign an agreement to guarantee that products using
       
    86    software based on IgH EtherCAT master stay compatible with the actual
       
    87    EtherCAT specification (which are released themselves as an open
       
    88    standard) as the (only) precondition to have the right to use EtherCAT
       
    89    Technology, IP and trade marks.
    71    \endverbatim
    90    \endverbatim
    72 */
    91 */
    73 
    92 
    74 /*****************************************************************************/
    93 /*****************************************************************************/