Add parameter documentation for read_setting_value

diff --git a/load_service.cc b/load_service.cc
index 8dc4de27bb3faf8c97c41f02e369ff0d121b085f..a45316ac64768fb084ffe80d22e550400e4e5f92 100644 (file)
--- a/load_service.cc
+++ b/load_service.cc
@@ -56,6 +56,12 @@ static string read_setting_name(string_iterator & i, string_iterator end)
 //
 // This function expects the string to be in an ASCII-compatible, single byte
 // encoding (the "classic" locale).
+//
+// Params:
+//    i  -  reference to string iterator through the line
+//    end -   iterator at end of line
+//    part_positions -  list of <int,int> to which the position of each setting value
+//                      part will be added as [start,end). May be null.
 static string read_setting_value(string_iterator & i, string_iterator end,
         std::list<std::pair<int,int>> * part_positions = nullptr)
 {