Skip to content

Document String variable in Parameters section of String functions #500

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 3, 2019
Merged

Document String variable in Parameters section of String functions #500

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Language/Variables/Data Types/String/Functions/c_str.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Converts the contents of a String as a C-style, null-terminated string. Note tha

[float]
=== Parameters
none
`myString`: a variable of type String

[float]
=== Returns
Expand Down
2 changes: 2 additions & 0 deletions Language/Variables/Data Types/String/Functions/concat.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ Appends the parameter to a String.

[float]
=== Parameters
`myString`: a variable of type String

`parameter`: *Allowed types are* String, string, char, byte, int, unsigned int, long, unsigned long, float, double, __FlashStringHelper(F() macro).

[float]
Expand Down
2 changes: 2 additions & 0 deletions Language/Variables/Data Types/String/Functions/remove.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ Modify in place a String removing chars from the provided index to the end of th

[float]
=== Parameters
`myString`: a variable of type String

`index`: a variable of type unsigned int

`count`: a variable of type unsigned int
Expand Down
2 changes: 2 additions & 0 deletions Language/Variables/Data Types/String/Functions/reserve.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ The String reserve() function allows you to allocate a buffer in memory for mani

[float]
=== Parameters
`myString`: a variable of type String

`size`: unsigned int declaring the number of bytes in memory to save for String manipulation


Expand Down