IODA
iodaNamespaceDoc.h
Go to the documentation of this file.
1 #pragma once
2 /*
3  * (C) Copyright 2020-2021 UCAR
4  *
5  * This software is licensed under the terms of the Apache Licence Version 2.0
6  * which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
7  */
8 
9 /// \file iodaNamespaceDoc.h
10 /// \brief This file defines some Doxygen namespace comments. No need to include in your code.
11 
12 /// \defgroup ioda IODA
13 /// \brief Everything IODA goes here!
14 
15 /// \defgroup ioda_language_interfaces Interfaces
16 /// \brief Per-language interfaces are documented here.
17 /// \ingroup ioda
18 
19 /// \defgroup ioda_cxx C++ interface
20 /// \brief Provides the C++ interface for IODA
21 /// \ingroup ioda_language_interfaces
22 
23 /// \defgroup ioda_c C interface
24 /// \brief Provides the C interface for ioda.
25 /// \ingroup ioda_language_interfaces
26 
27 /// \defgroup ioda_fortran Fortran interface
28 /// \brief The IODA Fortran interface (WIP)
29 /// \ingroup ioda_language_interfaces
30 
31 /// \defgroup ioda_python Python interface
32 /// \brief The IODA Python interface (WIP)
33 /// \ingroup ioda_language_interfaces
34 
35 /// \defgroup ioda_cxx_api API
36 /// \brief C++ API
37 /// \ingroup ioda_cxx
38 
39 /// \defgroup ioda_fortran_api API
40 /// \brief Fortran API
41 /// \ingroup ioda_fortran
42 
43 /// \defgroup ioda_engines_grp Engines
44 /// \brief The powerhouses of IODA
45 /// \ingroup ioda
46 
47 /// \defgroup ioda_engines_grp_HH HDF5 / HDFforHumans
48 /// \brief History and implementation of the HH backend.
49 /// \ingroup ioda_engines_grp
50 
51 /// \defgroup ioda_engines_grp_adding Adding a Backend Engine (Advanced)
52 /// \brief How are backend engines implemented?
53 /// \ingroup ioda_engines_grp
54 
55 /// \defgroup ioda_internals Internals
56 /// \brief Details internal to IODA
57 /// \ingroup ioda
58 
59 /// \defgroup ioda_internals_engines Engines
60 /// \brief Details internal to IODA's engines
61 /// \ingroup ioda_internals
62 
63 /// \defgroup ioda_internals_engines_types Types Across Interface Boundaries
64 /// \brief Details internal to IODA's engines
65 /// \ingroup ioda_internals_engines
66 
67 
68 #ifdef __cplusplus
69 
70 /// \brief The root-level namespace for the ioda library.
71 namespace ioda {
72 /// \brief Implementation details. Regular users should not use objects in this class
73 /// directly, though several user-intended classes inherit from objects here.
74 namespace detail {}
75 
76 } // namespace ioda
77 
78 #endif // __cplusplus