From: Davin McCall <davmac@davmac.org>
Date: Wed, 4 Nov 2015 22:08:37 +0000 (+0000)
Subject: Add parameter documentation for read_setting_value
X-Git-Tag: v0.01~140
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=491155645952a213f261ccf549ef52d553ab990d;p=oweals%2Fdinit.git

Add parameter documentation for read_setting_value
---

diff --git a/load_service.cc b/load_service.cc
index 8dc4de2..a45316a 100644
--- 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)
 {