inc/StringUtils.h

   1 //! \file StringUtils.h
   2
   3 #ifndef WIKIWALKER_STRINGUTILS_H
   4 #define WIKIWALKER_STRINGUTILS_H
   5
   6 #include <string>
   7
   8 namespace WikiWalker
   9 {
  10   //! A collection of string utilities
  11   namespace StringUtils
  12   {
  13     /*!
  14      * Checks whether a string begins with another string.
  15      * \param stringToTest the string that should be tested
  16      * \param beginning the search string
  17      * \returns true if first string begins with the second one, otherwise
  18      * false. Also returns false if either string is empty.
  19      */
  20     bool startsWith(const std::string& stringToTest,
  21                     const std::string& beginning);
  22   }  //  namespace StringUtils
  23 }  //  namespace WikiWalker
  24
  25 #endif  // WIKIWALKER_STRINGUTILS_H