resource/docs/c-doc/devdox/mainpage.dox

   1 //******************************************************************
   2 //
   3 // Copyright 2015 Samsung Electronics All Rights Reserved.
   4 //
   5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
   6 //
   7 // Licensed under the Apache License, Version 2.0 (the "License");
   8 // you may not use this file except in compliance with the License.
   9 // You may obtain a copy of the License at
  10 //
  11 //      http://www.apache.org/licenses/LICENSE-2.0
  12 //
  13 // Unless required by applicable law or agreed to in writing, software
  14 // distributed under the License is distributed on an "AS IS" BASIS,
  15 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16 // See the License for the specific language governing permissions and
  17 // limitations under the License.
  18 //
  19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  20
  21 /**
  22 @mainpage
  23
  24 This is documentation intended for internal use of developers actually
  25 working on the implementation code itself. At the moment this specific page
  26 is just a simplified placeholder.
  27
  28 <hr>
  29
  30 Quick starting points:
  31
  32 - @ref ca_overview which replicates an existing requirements doc.
  33   - An overview diagram in that document: @ref cao_overview
  34 - @ref ca_functional Minimal sample showing how diagrams and code doc can be
  35   integrated.
  36   - @ref caf_ovr_comm_netinterface a section with a minimal UML sketch
  37   - @ref caf_ovr_comm_netinterface_detail a more detailed UML diagram
  38 - The 'Related Pages' tab
  39
  40 Then see CAEthernetInitializeServer() for...
  41 - CAInitializeEthernet()
  42 - other
  43 */