Skip to content
Snippets Groups Projects
Commit 253934eb authored by Julien Osman's avatar Julien Osman
Browse files

STYLE: Improve comments style and correct a typo

parent e165f2a2
No related branches found
No related tags found
No related merge requests found
...@@ -222,9 +222,10 @@ public: ...@@ -222,9 +222,10 @@ public:
/** Format the metadata to JSON */ /** Format the metadata to JSON */
std::string ToJSON(bool multiline=false) const; std::string ToJSON(bool multiline=false) const;
/** Import metadata from a string keywordlist (will skip /** Import metadata from a string keywordlist.
* MDGeom::SensorGeometry). Returns True if all keywords were * Will skip MDGeom::SensorGeometry).
* parsed correctly */ * Returns True if all keywords were parsed correctly.
*/
bool FromKeywordlist(const Keywordlist&); bool FromKeywordlist(const Keywordlist&);
}; };
...@@ -267,23 +268,23 @@ public: ...@@ -267,23 +268,23 @@ public:
/** if all bands share the same value of a key, put it at top level */ /** if all bands share the same value of a key, put it at top level */
void compact(); 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 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; 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. * Each KeywordList contain the metadata of a band.
* */ */
void ToBandKeywordlists(KeywordlistVector&) const; void ToBandKeywordlists(KeywordlistVector&) const;
/** Import metadata from a list of keywordlist (will skip /** Import metadata from a list of keywordlist.
* MDGeom::SensorGeometry).
* The first KeywordList contains the metadata common to all the bands. * 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.
* Returns True if all keywords were * Will skip MDGeom::SensorGeometry.
* parsed correctly */ * Returns True if all keywords were parsed correctly.
*/
bool FromKeywordlists(const KeywordlistVector&); bool FromKeywordlists(const KeywordlistVector&);
}; };
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment