From 0950253ca6a21ca4d114a8743b4b9990ec0398be Mon Sep 17 00:00:00 2001 From: nds Date: Tue, 18 Feb 2020 08:53:37 +0300 Subject: [PATCH] 0031366: Documentation - Doxygen warnings in Standard_Dump.hxx --- src/Standard/Standard_Dump.hxx | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/src/Standard/Standard_Dump.hxx b/src/Standard/Standard_Dump.hxx index 2c1e989cbb..72e7ccb45c 100644 --- a/src/Standard/Standard_Dump.hxx +++ b/src/Standard/Standard_Dump.hxx @@ -214,18 +214,17 @@ public: //! @return text presentation Standard_EXPORT static TCollection_AsciiString FormatJson (const Standard_SStream& theStream, const Standard_Integer theIndent = 3); - //! Converts stream into map of values. Values are not empty if the stream contains at least two values. + //! Converts stream into map of values. //! - //! The one level stream example: key_1\value_1\key_2\value_2 - //! In output: theStreamKey equals class_name, theValues contains key_1, value_1, key_2, and value_2. + //! The one level stream example: 'key_1: value_1, key_2: value_2' + //! In output: values contain 'key_1: value_1' and 'key_2: value_2'. //! - //! Two level stream example: key_1\value_1\key_2\value_2\key_3subclass_key_1\subclass_value1 - //! In output: theStreamKey equals class_name, theValues contains key_1, value_1, key_2, and value_2, key_3 and - //! subclass_key_1\subclass_value1. - //! The last value might be processed later using the same method. + //! The two level stream example: 'key_1: value_1, key_2: value_2, key_3: {sublevel_key_1: sublevel_value_1}, key_4: value_4' + //! In output values contain 'key_1: value_1', 'key_2: value_2', 'key_3: {sublevel_key_1: sublevel_value_1}' and 'key_4: value_4'. + //! The sublevel value might be processed later using the same method. //! - //! @param theStream stream value - //! @param theKeyToValues [out] container of split values + //! @param theStreamStr stream value + //! @param theKeyToValues [out] container of split values. It contains key to value and position of the value in the stream text Standard_EXPORT static Standard_Boolean SplitJson (const TCollection_AsciiString& theStreamStr, NCollection_IndexedDataMap& theKeyToValues); -- 2.20.1