Doxygen cleanup and bump version to 2.0.0. (patch to release/2.0.0) (…

…#308) * Doxygen cleanup and bump version to 2.0.0. * Copyright * Copyright * Copyright
JCSDA · Jun 11, 2021 · 6fca1b5 · 6fca1b5
1 parent 6eacee5
commit 6fca1b5
Show file tree

Hide file tree

Showing 12 changed files with 12 additions and 122 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,5 +1,5 @@
 #
-# (C) Copyright 2017-2020 UCAR.
+# (C) Copyright 2017-2021 UCAR.
 #
 # This software is licensed under the terms of the Apache Licence Version 2.0
 # which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.

diff --git a/COPYING b/COPYING
@@ -175,7 +175,7 @@
 
    END OF TERMS AND CONDITIONS
 
-   Copyright 2017 UCAR
+   Copyright 2017-2021 UCAR
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@ CodeCov:[![codecov](https://codecov.io/gh/JCSDA-internal/ioda/branch/develop/gra
 
 JEDI Interface for Observation Data Access (IODA)
 
-(C) Copyright 2017-2020 UCAR.
+(C) Copyright 2017-2021 UCAR.
 
 This software is licensed under the terms of the Apache Licence Version 2.0
 which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.

diff --git a/src/distribution/InefficientDistribution.cc b/src/distribution/InefficientDistribution.cc
@@ -18,13 +18,6 @@
 #include "oops/util/DateTime.h"
 #include "oops/util/Logger.h"
 
-// -----------------------------------------------------------------------------
-/*!
- * \brief Inefficient distribution
- *
- * \details This method distributes all observations to all processes.
- */
-
 // -----------------------------------------------------------------------------
 
 namespace ioda {

diff --git a/src/engines/CMakeLists.txt b/src/engines/CMakeLists.txt
@@ -22,17 +22,17 @@ endif()
 
 # Versioning. This is not part of a project line due to conflicts with how ioda can
 # include this code in-source.
-set(IODA_ENGINES_MAJOR 0 CACHE INTERNAL "ioda engines major version" FORCE)
-set(IODA_ENGINES_MINOR 9 CACHE INTERNAL "ioda engines minor version" FORCE)
-set(IODA_ENGINES_REVISION 9 CACHE INTERNAL "ioda engines revision version" FORCE)
+set(IODA_ENGINES_MAJOR 2 CACHE INTERNAL "ioda engines major version" FORCE)
+set(IODA_ENGINES_MINOR 0 CACHE INTERNAL "ioda engines minor version" FORCE)
+set(IODA_ENGINES_REVISION 0 CACHE INTERNAL "ioda engines revision version" FORCE)
 set(IODA_ENGINES_TWEAK 0 CACHE INTERNAL "ioda engines tweak version" FORCE)
 set(IODA_ENGINES_VERSION ${IODA_ENGINES_MAJOR}.${IODA_ENGINES_MINOR}.${IODA_ENGINES_REVISION}.${IODA_ENGINES_TWEAK}
 	CACHE INTERNAL "ioda engines version" FORCE)
 
 set( CMAKE_DIRECTORY_LABELS "ioda-engines" )
 
 if(IODA_ENGINES_IS_PROJECT)
-	project(ioda_engines VERSION 0.9.9 LANGUAGES C CXX)
+	project(ioda_engines VERSION 2.0.0 LANGUAGES C CXX)
 	set_property(GLOBAL PROPERTY USE_FOLDERS ON)
 	if(NOT CMAKE_BUILD_TYPE)
 		set(CMAKE_BUILD_TYPE "RelWithDebInfo" CACHE STRING "Choose the type of build, options are: None(CMAKE_CXX_FLAGS or CMAKE_C_FLAGS used) Debug Release RelWithDebInfo MinSizeRel." FORCE)

diff --git a/src/engines/README.md b/src/engines/README.md
@@ -1,12 +1,8 @@
-# ioda-engines
+# IODA-engines
 
-ioda-engines provides unified in-memory and in-file data storage. The rest of jedi
-depends on ioda to provide the data that different applications need, and ioda uses
-ioda-engines to manipulate the data.
-
-This repository represents part of the OOPS/IODA/UFO changes. Documentation is still being
-written. Basically, we wanted to refactor ioda and provide a common observation store that
-was aware of metadata and could store multidimensional data.
+IODA-engines provides unified in-memory and in-file data storage. The rest of JEDI
+depends on IODA to provide the data that different applications need, and IODA uses
+IODA-engines to manipulate the data.
 
 ## Quick start
 
@@ -16,8 +12,6 @@ Most of the library is implemented in a few key classes under namespace ```ioda`
 - ioda::Variable represents a single variable. It may also contain Attributes (ioda::Attribute).
 - The ioda::Has_Attributes and ioda::Has_Variables classes are helper classes.
 
-See [the Walkthrough page](@ref Walkthrough) for tutorials and usage guides.
-
 
 Errata:
 

diff --git a/src/engines/docs/AddingEngines.md b/src/engines/docs/AddingEngines.md
@@ -114,6 +114,5 @@ your data.
 ## Variable data space selectors
 
 Variables support partial reads and writes through the "file_space" and "mem_space" parameters in
-their read and write functions. 
+their read and write functions. See the existing implementations or contact the authors for hints here.
 
-TODO: Finish this.
diff --git a/src/engines/docs/DataSpaces.md b/src/engines/docs/DataSpaces.md
diff --git a/src/engines/docs/Groups.md b/src/engines/docs/Groups.md
diff --git a/src/engines/docs/Layout.md b/src/engines/docs/Layout.md
diff --git a/src/engines/docs/Types.md b/src/engines/docs/Types.md
diff --git a/src/engines/docs/Walkthrough.md b/src/engines/docs/Walkthrough.md