WebSVN – tpanel – Diff – /trunk/tnameformat.cpp

 /*
- * Copyright (C) 2020 by Andreas Theofilu <andreas@theosys.at>
+ * Copyright (C) 2020, 2021 by Andreas Theofilu <andreas@theosys.at>
+ *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 3 of the License, or
  * (at your option) any later version.
 using namespace std;
 std::string TNameFormat::mStr;
+/**
+ * @brief TNameFormat::TNameFormat constructor
+ */
 TNameFormat::TNameFormat()
+{
 	DECL_TRACER("TNameFormat::TNameFormat()");
+}
+/**
+ * @brief TNameFormat::~TNameFormat destructor
+ */
 TNameFormat::~TNameFormat()
+{
 	DECL_TRACER("TNameFormat::~TNameFormat()");
+}
+/**
+ * @brief TNameFormat::toValidName filters invalid characters.
+ *
+ * This method filters a string for invalid characters. Allowed are all
+ * characters between 0 to 9, a to z, A to Z and the underline(_). All other
+ * characters will be filtered out.
+ *
+ * @param str   The string to filter
+ * @return A string containing only the valid characters.
+ */
 string TNameFormat::toValidName(string& str)
+{
 	DECL_TRACER("TNameFormat::toValidName(string& str)");
 	string ret;
+	}
 	return ret;
+}
+/**
+ * @brief TNameFormat::cutNumbers filters everything but digit symbols.
+ *
+ * This method filters a string for digits. It filters out all characters
+ * except digits.
+ *
+ * @param str   String to filter.
+ * @return A string containing only digits or an empty string if there were
+ * no digits in \p str.
+ */
 string TNameFormat::cutNumbers(string& str)
+{
 	DECL_TRACER("TNameFormat::cutNumbers(string& str)");
 	string ret;
+	}
 	return ret;
+}
+/**
+ * @brief TNameFormat::toShortName filters a sequence starting with a blank and ends with a dot.
+ *
+ * This method filters any sequence starting with one or more blanks (' ') and
+ * end with a dot (.).
+ *
+ * @param str   The string to filter
+ * @return A string containing no sequence equal (" .");
+ */
 string TNameFormat::toShortName(string& str)
+{
 	DECL_TRACER("TNameFormat::toShortName(string& str)");
 	string ret;
 	bool ignore = false;
+	}
 	return ret;
+}
+/**
+ * @brief TNameFormat::transFontName Replaces blanks and percent to unterline.
+ *
+ * This method replaces every blank (' ') and percent (%) with an underline (_).
+ * Then the seuqence **.ttf** is replace by **.woff**.
+ *
+ * @param str   The string to evaluate
+ * @return A filtered string.
+ */
 string TNameFormat::transFontName(string& str)
+{
 	DECL_TRACER("TNameFormat::transFontName(string& str)");
 	string ret;
 	replace(ret, ".ttf", ".woff");
 	return ret;
+}
+/**
+ * @brief TNameFormat::toURL converts a URL into a safe URL.
+ *
+ * This method filters a URL in a way, that all possible dangerous characters
+ * are replaced by a percent (%) and the byte value.
+ *
+ * @param str   An URL to evaluate
+ * @return A safe URL.
+ */
 string TNameFormat::toURL(string& str)
+{
 	DECL_TRACER("TNameFormat::toURL(string& str)");
 	string ret;
+	}
 	return ret;
+}
+/**
+ * @brief TNameFormat::EncodeTo convert into another character set.
+ *
+ * This method takes a string and converts it into another character set.
+ *
+ * @param buf   A pointer to a buffer large enough to hold the result.
+ * @param len   The length of the buffer \p buf.
+ * @param str   A pointer to a string. The content will be converted.
+ * @param from  The name of the character set in \p str.
+ * @param to    The name of the target charcter set.
+ * @return The pointer \p buf. This buffer is filled up to the length of \p str
+ * or the zero byte. Whichever comes first.
+ */
 char *TNameFormat::EncodeTo(char* buf, size_t *len, const string& str, const string& from, const string& to)
+{
 	DECL_TRACER("TNameFormat::EncodeTo(char* buf, size_t *len, const string& str, const string& from, const string& to)");
 	if (!buf || str.empty())

Subversion Repositories tpanel

(root)/trunk/tnameformat.cpp @ 21 – Rev 2 → 21