doc/directories.dox

   1 /***
   2
   3 \dir bin
   4 \brief Helper scripts.
   5
   6
   7 \dir cmake
   8 \brief Contains CMake modules.
   9
  10
  11 \dir doc
  12 \brief Home of the documentation.
  13
  14 Everything that is not in the README.md or generated from sources.
  15
  16
  17 \dir examples
  18 \brief Location of all examples using the library.
  19
  20
  21 \dir extern
  22 \brief Contains external dependencies, contained as part of the
  23 repository.
  24
  25
  26 \dir include
  27 \brief Public header files.
  28
  29
  30 \dir src
  31 \brief Contains the source of the library.
  32
  33
  34 \dir src/marnav/ais
  35 \brief All AIS related classes (messages, utilities, etc.).
  36
  37 All AIS related stuff. Note that despite the AIS builds on
  38 the NMEA protocol (`VDM`, `VDO` sentences), the package does not
  39 have any dependencies to the `nmea` package.
  40
  41
  42 \dir src/marnav/geo
  43 \brief Collection of geographic and geodesic functions.
  44
  45
  46 \dir src/marnav/io
  47 \brief Input/Output stuff to communicate with the outside world.
  48
  49 Input output stuff, mainly for NMEA and SeaTalk. Please note,
  50 that this package is not mandatory. It is perfectly fine
  51 to use the `nmea` package without `io`.
  52
  53
  54 \dir src/marnav/math
  55 \brief Generic math stuff.
  56
  57
  58 \dir src/marnav/nmea
  59 \brief All NMEA-0183 related classes (sentences, utilities, etc.)
  60
  61
  62 \dir src/marnav/seatalk
  63 \brief Everything SeaTalk-1 related.
  64
  65
  66 \dir src/marnav/utils
  67 \brief Common utilities.
  68
  69
  70 \dir test
  71 \brief Contains all tests.
  72
  73 This directory contains all unit tests as well as integration tests,
  74 which are executed on continuous integration builds. Examples are to
  75 be found in the directory examples.
  76
  77 */