Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitb9ae59c

Browse files
committed
#206-fix missing \briefs in doxygen strings
Completed. Validated.
1 parent6110a76 commitb9ae59c

File tree

1 file changed

+35
-35
lines changed

1 file changed

+35
-35
lines changed

‎cpp-strings/cppstrings.h‎

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -501,7 +501,7 @@ namespace pcs // i.e. "pythonic c++ strings"
501501

502502

503503
//--- contains_n() ------------------------------------
504-
/** Returns true if the passed string is found within the slice str[start:start+count-1], or false otherwise.
504+
/**\briefReturns true if the passed string is found within the slice str[start:start+count-1], or false otherwise.
505505
*
506506
* This is a c++ implementation of Python keyword 'in' applied to Python sliced strings.
507507
*/
@@ -553,25 +553,25 @@ namespace pcs // i.e. "pythonic c++ strings"
553553

554554

555555
//--- endswith() --------------------------------------
556-
/** Returns true if the string ends with the specified suffix, otherwise returns false. Test begins at start position and stops at end position.*/
556+
/**\briefReturns true if the string ends with the specified suffix, otherwise returns false. Test begins at start position and stops at end position.*/
557557
inlineconstboolendswith(const CppStringT& suffix,const size_type start,const size_type end)constnoexcept
558558
{
559559
returnthis->substr(start, end - start +1).MyBaseClass::ends_with(suffix);
560560
}
561561

562-
/** Returns true if the string ends with the specified suffix, otherwise returns false. Test begins at start of string and stops at end position.*/
562+
/**\briefReturns true if the string ends with the specified suffix, otherwise returns false. Test begins at start of string and stops at end position.*/
563563
inlineconstboolendswith(const CppStringT& suffix,const size_type end)constnoexcept
564564
{
565565
returnthis->substr(0, end).MyBaseClass::ends_with(suffix);
566566
}
567567

568-
/** Returns true if the string ends with the specified suffix, otherwise returns false. Test runs on the whole string.*/
568+
/**\briefReturns true if the string ends with the specified suffix, otherwise returns false. Test runs on the whole string.*/
569569
inlineconstboolendswith(const CppStringT& suffix)constnoexcept
570570
{
571571
returnstatic_cast<constbool>(MyBaseClass::ends_with(suffix));
572572
}
573573

574-
/** Returns true if the string ends with any of the specified suffixes, otherwise returns false. Test begins at start position and stops at end position.*/
574+
/**\briefReturns true if the string ends with any of the specified suffixes, otherwise returns false. Test begins at start position and stops at end position.*/
575575
constboolendswith(const std::initializer_list<CppStringT>& suffixes,const size_type start,const size_type end)constnoexcept
576576
{
577577
if (start > end)
@@ -587,27 +587,27 @@ namespace pcs // i.e. "pythonic c++ strings"
587587

588588

589589
//--- endswith_n() ------------------------------------
590-
/** Returns true if the string ends with the specified suffix, otherwise returns false. Test begins at start position and stops after count positions.*/
590+
/**\briefReturns true if the string ends with the specified suffix, otherwise returns false. Test begins at start position and stops after count positions.*/
591591
inlineconstboolendswith_n(const CppStringT& suffix,const size_type start,const size_type count)constnoexcept
592592
{
593593
returnendswith(suffix, start, start + count -1);
594594
}
595595

596-
/** Returns true if the string ends with the specified suffix, otherwise returns false. Test begins at position 0 and stops after count positions.*/
596+
/**\briefReturns true if the string ends with the specified suffix, otherwise returns false. Test begins at position 0 and stops after count positions.*/
597597
inlineconstboolendswith_n(const CppStringT& suffix,const size_type count)constnoexcept
598598
{
599599
returnendswith(suffix,0, count -1);
600600
}
601601

602-
/** Returns true if the string ends with any of the specified suffixes, otherwise returns false. Test begins at start position and stops after count positions.*/
602+
/**\briefReturns true if the string ends with any of the specified suffixes, otherwise returns false. Test begins at start position and stops after count positions.*/
603603
inlineconstboolendswith_n(const std::initializer_list<CppStringT>& suffixes,const size_type start,const size_type count)constnoexcept
604604
{
605605
returnendswith(suffixes, start, start + count -1);
606606
}
607607

608608

609609
//--- expand_tabs() -----------------------------------
610-
/** Returns a copy of the string where all tab characters are replaced by one or more spaces, depending on the current column and the given tab size.*/
610+
/**\briefReturns a copy of the string where all tab characters are replaced by one or more spaces, depending on the current column and the given tab size.*/
611611
CppStringTexpand_tabs(const size_type tabsize =8)constnoexcept
612612
{
613613
const size_type tabsize_{ tabsize ==0 ?1 : tabsize };
@@ -636,7 +636,7 @@ namespace pcs // i.e. "pythonic c++ strings"
636636

637637

638638
//--- find() ------------------------------------------
639-
/** Returns the lowest index in the string where substring sub is found within the slice str[start:end], or -1 (i.e. 'npos') if sub is not found.
639+
/**\briefReturns the lowest index in the string where substring sub is found within the slice str[start:end], or -1 (i.e. 'npos') if sub is not found.
640640
*
641641
* Note: this method should be used only if you need to know the position of
642642
* sub. To check if sub is a substring or not, use the method contains().
@@ -659,7 +659,7 @@ namespace pcs // i.e. "pythonic c++ strings"
659659

660660

661661
//--- find_n() ----------------------------------------
662-
/** Returns the lowest index in the string where substring sub is found within the slice str[start:start+count-1], or -1 (i.e. 'npos') if sub is not found.
662+
/**\briefReturns the lowest index in the string where substring sub is found within the slice str[start:start+count-1], or -1 (i.e. 'npos') if sub is not found.
663663
*
664664
* Note: this method should be used only if you need to know the position of
665665
* sub. To check if sub is a substring or not, use the method contains_n().
@@ -686,7 +686,7 @@ namespace pcs // i.e. "pythonic c++ strings"
686686
}
687687
}
688688

689-
/** Returns the lowest index in the string where substring sub is found within the slice str[0:count-1], or -1 (i.e. 'npos') if sub is not found.
689+
/**\briefReturns the lowest index in the string where substring sub is found within the slice str[0:count-1], or -1 (i.e. 'npos') if sub is not found.
690690
*
691691
* Note: this method should be used only if you need to know the position of
692692
* sub. To check if sub is a substring or not, use the method contains_n().
@@ -705,7 +705,7 @@ namespace pcs // i.e. "pythonic c++ strings"
705705

706706

707707
//--- format() ----------------------------------------
708-
/** Formats this string according to c++20 std::format() specification. Returns this string.*/
708+
/**\briefFormats this string according to c++20 std::format() specification. Returns this string.*/
709709
template<typename T,class... ArgsT>
710710
inline CppStringT&format(
711711
const std::basic_format_string<T, std::type_identity_t<ArgsT>...> frmt,
@@ -735,7 +735,7 @@ namespace pcs // i.e. "pythonic c++ strings"
735735

736736

737737
//--- index() -----------------------------------------
738-
/** Like find(const CppStringT&), but raises NotFoundException when the substring sub is not found.
738+
/**\briefLike find(const CppStringT&), but raises NotFoundException when the substring sub is not found.
739739
*
740740
* \see index_n(), rindex() and rindex_n().
741741
* \see find(), find_n(), rfind() and rfind_n().
@@ -751,7 +751,7 @@ namespace pcs // i.e. "pythonic c++ strings"
751751

752752

753753
//--- index_n() ---------------------------------------
754-
/** Like find_n(sub, start, count), but raises NotFoundException when the substring is not found.
754+
/**\briefLike find_n(sub, start, count), but raises NotFoundException when the substring is not found.
755755
*
756756
* \see index_n(), rindex() and rindex_n().
757757
* \see find(), find_n(), rfind() and rfind_n().
@@ -761,7 +761,7 @@ namespace pcs // i.e. "pythonic c++ strings"
761761
returnindex(sub, start, start + count -1);
762762
}
763763

764-
/** Like find_n(sub, count), but raises NotFoundException when the substring is not found.
764+
/**\briefLike find_n(sub, count), but raises NotFoundException when the substring is not found.
765765
*
766766
* \see index_n(), rindex() and rindex_n().
767767
* \see find(), find_n(), rfind() and rfind_n().
@@ -1139,7 +1139,7 @@ namespace pcs // i.e. "pythonic c++ strings"
11391139

11401140

11411141
//--- partition() -------------------------------------
1142-
/** Splits the string at the first occurrence of sep, and returns a 3-items vector containing the part before the separator, the separator itself, and the part after the separator.
1142+
/**\briefSplits the string at the first occurrence of sep, and returns a 3-items vector containing the part before the separator, the separator itself, and the part after the separator.
11431143
*
11441144
* If the separator is not found, returns a 3-items vector
11451145
* containing the string itself, followed by two empty strings.
@@ -1209,7 +1209,7 @@ namespace pcs // i.e. "pythonic c++ strings"
12091209

12101210

12111211
//--- rfind() -----------------------------------------
1212-
/** Returns the highest index in the string where substring sub is found within the slice str[start:end], or -1 (i.e. 'npos') if sub is not found.
1212+
/**\briefReturns the highest index in the string where substring sub is found within the slice str[start:end], or -1 (i.e. 'npos') if sub is not found.
12131213
*
12141214
* Note that this is an offset from the start of the string, not the end.
12151215
*
@@ -1236,7 +1236,7 @@ namespace pcs // i.e. "pythonic c++ strings"
12361236
}
12371237

12381238

1239-
/** Returns the highest index in the string where substring sub is found starting at start position in string, or -1 (i.e. 'npos') if sub is not found.
1239+
/**\briefReturns the highest index in the string where substring sub is found starting at start position in string, or -1 (i.e. 'npos') if sub is not found.
12401240
*
12411241
* Note that this is an offset from the start of the string, not the end.
12421242
*
@@ -1256,7 +1256,7 @@ namespace pcs // i.e. "pythonic c++ strings"
12561256
}
12571257

12581258

1259-
/** Returns the highest index in the string where C-substring sub is found in the whole string, or -1 (i.e. 'npos') if sub is not found.
1259+
/**\briefReturns the highest index in the string where C-substring sub is found in the whole string, or -1 (i.e. 'npos') if sub is not found.
12601260
*
12611261
* Note that this is an offset from the start of the string, not the end.
12621262
*
@@ -1277,7 +1277,7 @@ namespace pcs // i.e. "pythonic c++ strings"
12771277

12781278

12791279
//--- rfind_n() ---------------------------------------
1280-
/** Returns the highest index in the string where substring sub is found within the slice str[start:start+count-1], or -1 (i.e. 'npos') if sub is not found.
1280+
/**\briefReturns the highest index in the string where substring sub is found within the slice str[start:start+count-1], or -1 (i.e. 'npos') if sub is not found.
12811281
*
12821282
* Note: this method should be used only if you need to know the position
12831283
* of sub. To check if sub is a substring or not, use the method contains_n().
@@ -1290,7 +1290,7 @@ namespace pcs // i.e. "pythonic c++ strings"
12901290
returnrfind(sub, start, start + count -1);
12911291
}
12921292

1293-
/** Returns the highest index in the string where substring sub is found within the slice str[0:count-1], or -1 (i.e. 'npos') if sub is not found.
1293+
/**\briefReturns the highest index in the string where substring sub is found within the slice str[0:count-1], or -1 (i.e. 'npos') if sub is not found.
12941294
*
12951295
* Note: this method should be used only if you need to know the position
12961296
* of sub. To check if sub is a substring or not, use the method contains_n().
@@ -1308,7 +1308,7 @@ namespace pcs // i.e. "pythonic c++ strings"
13081308

13091309

13101310
//--- rindex() ----------------------------------------
1311-
/** Like rfind(sub, start, end), but raises NotFoundException when the substring is not found.
1311+
/**\briefLike rfind(sub, start, end), but raises NotFoundException when the substring is not found.
13121312
*
13131313
* \see index(), index_n() and rindex_n().
13141314
* \see find(), find_n(), rfind() and rfind_n().
@@ -1322,7 +1322,7 @@ namespace pcs // i.e. "pythonic c++ strings"
13221322
return ret_value;
13231323
}
13241324

1325-
/** Like rfind(sub, start), but raises NotFoundException when the substring is not found.
1325+
/**\briefLike rfind(sub, start), but raises NotFoundException when the substring is not found.
13261326
*
13271327
* \see index(), index_n() and rindex_n().
13281328
* \see find(), find_n(), rfind() and rfind_n().
@@ -1332,7 +1332,7 @@ namespace pcs // i.e. "pythonic c++ strings"
13321332
returnrindex(sub, start,this->size() -1);
13331333
}
13341334

1335-
/** Like rfind(sub), but raises NotFoundException when the substring is not found.
1335+
/**\briefLike rfind(sub), but raises NotFoundException when the substring is not found.
13361336
*
13371337
* \see index(), index_n() and rindex_n().
13381338
* \see find(), find_n(), rfind() and rfind_n().
@@ -1344,7 +1344,7 @@ namespace pcs // i.e. "pythonic c++ strings"
13441344

13451345

13461346
//--- rindex_n() --------------------------------------
1347-
/** Like rfind_n(sub, start, count), but raises NotFoundException when the substring is not found.
1347+
/**\briefLike rfind_n(sub, start, count), but raises NotFoundException when the substring is not found.
13481348
*
13491349
* \see index_n(), rindex() and rindex_n().
13501350
* \see find(), find_n(), rfind() and rfind_n().
@@ -1354,7 +1354,7 @@ namespace pcs // i.e. "pythonic c++ strings"
13541354
returnrindex(sub, start, start + count -1);
13551355
}
13561356

1357-
/** Like rfind_n(sub, count), but raises NotFoundException when the substring is not found.
1357+
/**\briefLike rfind_n(sub, count), but raises NotFoundException when the substring is not found.
13581358
*
13591359
* \see index_n(), rindex() and rindex_n().
13601360
* \see find(), find_n(), rfind() and rfind_n().
@@ -1381,7 +1381,7 @@ namespace pcs // i.e. "pythonic c++ strings"
13811381

13821382

13831383
//--- rpartition() -------------------------------------
1384-
/** Splits the string at the last occurrence of sep, and returns a 3-items vector containing the part before the separator, the separator itself, and the part after the separator.
1384+
/**\briefSplits the string at the last occurrence of sep, and returns a 3-items vector containing the part before the separator, the separator itself, and the part after the separator.
13851385
*
13861386
* If the separator is not found, returns a 3-items vector
13871387
* containing the string itself, followed by two empty strings.
@@ -1650,25 +1650,25 @@ namespace pcs // i.e. "pythonic c++ strings"
16501650

16511651

16521652
//--- startswith() ------------------------------------
1653-
/** Returns true if the string starts with the specified prefix, otherwise returns false. Test begins at start position and stops at end position.*/
1653+
/**\briefReturns true if the string starts with the specified prefix, otherwise returns false. Test begins at start position and stops at end position.*/
16541654
inlineconstboolstartswith(const CppStringT& prefix,const size_type start,const size_type end)constnoexcept
16551655
{
16561656
returnthis->substr(start, end - start +1).MyBaseClass::starts_with(prefix);
16571657
}
16581658

1659-
/** Returns true if the string starts with the specified prefix, otherwise returns false. Test begins at start position and stops at end of string.*/
1659+
/**\briefReturns true if the string starts with the specified prefix, otherwise returns false. Test begins at start position and stops at end of string.*/
16601660
inlineconstboolstartswith(const CppStringT& prefix,const size_type start)constnoexcept
16611661
{
16621662
returnstartswith(prefix, start,this->size() -1);
16631663
}
16641664

1665-
/** Returns true if the string starts with the specified prefix, otherwise returns false. Test runs on the whole string.*/
1665+
/**\briefReturns true if the string starts with the specified prefix, otherwise returns false. Test runs on the whole string.*/
16661666
inlineconstboolstartswith(const CppStringT& prefix)constnoexcept
16671667
{
16681668
returnthis->starts_with(prefix);
16691669
}
16701670

1671-
/** Returns true if the string starts with any of the specified prefixes, otherwise returns false. Test begins at start position and stops at end of string.*/
1671+
/**\briefReturns true if the string starts with any of the specified prefixes, otherwise returns false. Test begins at start position and stops at end of string.*/
16721672
inlineconstboolstartswith(const std::initializer_list<CppStringT>& prefixes,const size_type start,const size_type end)constnoexcept
16731673
{
16741674
if (start > end)
@@ -1684,19 +1684,19 @@ namespace pcs // i.e. "pythonic c++ strings"
16841684

16851685

16861686
//--- startswith_n() ----------------------------------
1687-
/** Returns true if the string starts with the specified suffix, otherwise returns false. Test begins at start position and stops after count positions.*/
1687+
/**\briefReturns true if the string starts with the specified suffix, otherwise returns false. Test begins at start position and stops after count positions.*/
16881688
inlineconstboolstartswith_n(const CppStringT& prefix,const size_type start,const size_type count)constnoexcept
16891689
{
16901690
returnthis->substr(start, count).MyBaseClass::starts_with(prefix);
16911691
}
16921692

1693-
/** Returns true if the string starts with the specified suffix, otherwise returns false. Test begins at position 0 and stops after count positions.*/
1693+
/**\briefReturns true if the string starts with the specified suffix, otherwise returns false. Test begins at position 0 and stops after count positions.*/
16941694
inlineconstboolstartswith_n(const CppStringT& prefix,const size_type count)constnoexcept
16951695
{
16961696
returnthis->substr(0, count).MyBaseClass::starts_with(prefix);
16971697
}
16981698

1699-
/** Returns true if the string starts with any of the specified suffixes, otherwise returns false. Test begins at start position and stops after count positions.*/
1699+
/**\briefReturns true if the string starts with any of the specified suffixes, otherwise returns false. Test begins at start position and stops after count positions.*/
17001700
inlineconstboolstartswith_n(const std::initializer_list<CppStringT>& prefix,const size_type start,const size_type count)constnoexcept
17011701
{
17021702
returnstartswith(prefix, start, count);

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp