From 5cdbcd6fa75700db3f5d1a03544108a3666dd504 Mon Sep 17 00:00:00 2001
From: Stephane ALBERT <stephane.albert@c-s.fr>
Date: Mon, 21 Sep 2015 12:04:40 +0200
Subject: [PATCH] DOC: Improved otb::DEMHandler documentation.
---
.../OSSIMAdapters/include/otbDEMHandler.h | 28 +++++++++++++++++--
1 file changed, 25 insertions(+), 3 deletions(-)
diff --git a/Modules/Adapters/OSSIMAdapters/include/otbDEMHandler.h b/Modules/Adapters/OSSIMAdapters/include/otbDEMHandler.h
index f614e4d6e3..7e51a0c791 100644
--- a/Modules/Adapters/OSSIMAdapters/include/otbDEMHandler.h
+++ b/Modules/Adapters/OSSIMAdapters/include/otbDEMHandler.h
@@ -107,8 +107,28 @@ public:
/** return true if the directoty contain DEM */
virtual bool IsValidDEMDirectory(const char* DEMDirectory);
- /** Open geoid file. */
+ /**
+ * \brief Open geoid file given its filename or throw an exception
+ * if geoid-file could not be loaded.
+ *
+ * \param geoidFile The filename of the geoid-file.
+ *
+ * \return <code>true</code> if geoid file has been changed or
+ * <code>false</code> if geod-file have been set before and could
+ * not be changed.
+ */
virtual bool OpenGeoidFile(const char* geoidFile);
+
+ /**
+ * \brief Open geoid file given its filename or throw an exception
+ * if geoid-file could not be loaded.
+ *
+ * \param geoidFile The filename of the geoid-file.
+ *
+ * \return <code>true</code> if geoid file has been changed or
+ * <code>false</code> if geod-file have been set before and could
+ * not be changed.
+ */
virtual bool OpenGeoidFile(const std::string& geoidFile);
/** Compute the height above MSL(Mean Sea Level) of a geographic point. */
@@ -126,7 +146,8 @@ public:
double GetDefaultHeightAboveEllipsoid() const;
/**
- * @return The number of elevation databases in the <code>ossimElevManager</code>.
+ * \return The number of elevation databases in the
+ * <code>ossimElevManager</code>.
*/
unsigned int GetDEMCount() const;
@@ -137,7 +158,8 @@ public:
std::string GetGeoidFile() const;
/**
- * Remove all the ossimElevationDatabases from the ossimElevManager.
+ * \brief Remove all the ossimElevationDatabases from the
+ * <code>ossimElevManager</code>.
*/
void ClearDEMs();
--
GitLab