Merge pull request #11587 from dmaziec1/ATCmdParser_doxygen_scanf

ATCmdParser doxygen header's documentation update for scanf

platform/ATCmdParser.h

@@ -271,6 +271,9 @@ public:
 
     /**
      * Direct scanf on underlying stream
+     * This function does not itself match whitespace in its format string, so \n is not significant to it.
+     * It should be used only when certain string is needed or format ends with certain character, otherwise
+     * it will fill the output with one character.
      * @see scanf
      *
      * @param format Format string to pass to scanf

platform/source/ATCmdParser.cpp

@@ -309,7 +309,6 @@ restart:
             if (whole_line_wanted && c != '\n') {
                 // Don't attempt scanning until we get delimiter if they included it in format
                 // This allows recv("Foo: %s\n") to work, and not match with just the first character of a string
-                // (scanf does not itself match whitespace in its format string, so \n is not significant to it)
             } else if (response) {
                 sscanf(_buffer + offset, _buffer, &count);
             }