]> sigrok.org Git - pulseview.git/blobdiff - pv/util.hpp
Random simplifications, cosmetics/whitespace/consistency fixes.
[pulseview.git] / pv / util.hpp
index 1cf2fe548bab8e725abae5f87d60611575cf0748..bc71624bf3109fc2cb498778e943ac7acb3480f0 100644 (file)
@@ -14,8 +14,7 @@
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+ * along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 
 #ifndef PULSEVIEW_UTIL_HPP
@@ -73,19 +72,16 @@ typedef boost::multiprecision::number<
  * @param unit The unit of quantity.
  * @param sign Whether or not to add a sign also for positive numbers.
  *
- * @return The formated value.
+ * @return The formatted value.
  */
-QString format_time_si(
-       const Timestamp& t,
-       SIPrefix prefix = SIPrefix::unspecified,
-       unsigned precision = 0,
-       QString unit = "s",
-       bool sign = true);
+QString format_time_si(const Timestamp& v,
+       SIPrefix prefix = SIPrefix::unspecified, unsigned precision = 0,
+       QString unit = "s", bool sign = true);
 
 /**
- * Wrapper around 'format_time_si()' that interpretes the given 'precision'
+ * Wrapper around 'format_time_si()' that interprets the given 'precision'
  * value as the number of decimal places if the timestamp would be formatted
- * without a SI prefix (using 'SIPrefix::none') and adjustes the precision to
+ * without a SI prefix (using 'SIPrefix::none') and adjusts the precision to
  * match the given 'prefix'
  *
  * @param t The value to format.
@@ -95,14 +91,10 @@ QString format_time_si(
  * @param unit The unit of quantity.
  * @param sign Whether or not to add a sign also for positive numbers.
  *
- * @return The formated value.
+ * @return The formatted value.
  */
-QString format_time_si_adjusted(
-       const Timestamp& t,
-       SIPrefix prefix,
-       unsigned precision = 0,
-       QString unit = "s",
-       bool sign = true);
+QString format_time_si_adjusted(const Timestamp& t, SIPrefix prefix,
+       unsigned precision = 0, QString unit = "s", bool sign = true);
 
 /**
  * Formats the given timestamp using "[+-]DD:HH:MM:SS.mmm uuu nnn ppp..." format.
@@ -115,11 +107,9 @@ QString format_time_si_adjusted(
  * @param precision The number of digits after the decimal separator.
  * @param sign Whether or not to add a sign also for positive numbers.
  *
- * @return The formated value.
+ * @return The formatted value.
  */
-QString format_time_minutes(
-       const Timestamp& t,
-       signed precision = 0,
+QString format_time_minutes(const Timestamp& t, signed precision = 0,
        bool sign = true);
 
 } // namespace util