From 253934eb90f14613fc1f3c33f69d0534fa2ed6f5 Mon Sep 17 00:00:00 2001
From: Julien Osman <julien.osman@c-s.fr>
Date: Fri, 24 Apr 2020 10:04:58 +0200
Subject: [PATCH] STYLE: Improve comments style and correct a typo
---
.../Core/Metadata/include/otbImageMetadata.h | 27 ++++++++++---------
1 file changed, 14 insertions(+), 13 deletions(-)
diff --git a/Modules/Core/Metadata/include/otbImageMetadata.h b/Modules/Core/Metadata/include/otbImageMetadata.h
index abd36d59eb..d27c902335 100644
--- a/Modules/Core/Metadata/include/otbImageMetadata.h
+++ b/Modules/Core/Metadata/include/otbImageMetadata.h
@@ -222,9 +222,10 @@ public:
/** Format the metadata to JSON */
std::string ToJSON(bool multiline=false) const;
- /** Import metadata from a string keywordlist (will skip
- * MDGeom::SensorGeometry). Returns True if all keywords were
- * parsed correctly */
+ /** Import metadata from a string keywordlist.
+ * Will skip MDGeom::SensorGeometry).
+ * Returns True if all keywords were parsed correctly.
+ */
bool FromKeywordlist(const Keywordlist&);
};
@@ -267,23 +268,23 @@ public:
/** if all bands share the same value of a key, put it at top level */
void compact();
- /** Export the Metadata as a list of KeywordList
+ /** Export the Metadata as a list of KeywordList.
* The first KeywordList contains the metadata common to all the bands.
- * The following KeywordList contain the metadata of the bands.
- * */
+ * The following KeywordList contains the metadata of the bands.
+ */
void ToKeywordlists(KeywordlistVector&) const;
- /** Export the bands of the Metadata as a list of KeywordList
+ /** Export the bands of the Metadata as a list of KeywordList.
* Each KeywordList contain the metadata of a band.
- * */
+ */
void ToBandKeywordlists(KeywordlistVector&) const;
- /** Import metadata from a list of keywordlist (will skip
- * MDGeom::SensorGeometry).
+ /** Import metadata from a list of keywordlist.
* The first KeywordList contains the metadata common to all the bands.
- * The following KeywordList contain the metadata of the bands.
- * Returns True if all keywords were
- * parsed correctly */
+ * The following KeywordList contains the metadata of the bands.
+ * Will skip MDGeom::SensorGeometry.
+ * Returns True if all keywords were parsed correctly.
+ */
bool FromKeywordlists(const KeywordlistVector&);
};
--
GitLab