From 078edc158da7906ba72e7e6528e1a811e07270e7 Mon Sep 17 00:00:00 2001
From: Marti Bolivar <mbolivar@mit.edu>
Date: Mon, 29 Nov 2010 01:49:26 -0500
Subject: Finished converting the Arduino docs

---
 docs/source/lang/unimplemented/stringobject.rst | 89 +++++++++++++++++++++++++
 1 file changed, 89 insertions(+)
 create mode 100644 docs/source/lang/unimplemented/stringobject.rst

(limited to 'docs/source/lang/unimplemented/stringobject.rst')

diff --git a/docs/source/lang/unimplemented/stringobject.rst b/docs/source/lang/unimplemented/stringobject.rst
new file mode 100644
index 0000000..e47ed7e
--- /dev/null
+++ b/docs/source/lang/unimplemented/stringobject.rst
@@ -0,0 +1,89 @@
+.. _lang-stringobject:
+
+String
+======
+
+Description
+-----------
+
+The String class, part of the core as of version 0019, allows you to
+use and manipulate strings of text in more complex ways than character
+arrays do. You can concatenate Strings, append to them, search for and
+replace substrings, and more. It takes more memory than a simple
+character array, but it is also more useful.
+
+
+
+For reference, character arrays are referred to as strings with a
+small s, and instances of the String class are referred to as
+Strings with a capital S. Note that constant strings, specified in
+"double quotes" are treated as char arrays, not instances of the
+String class.
+
+
+
+Functions
+---------
+
+
+-  `String <http://arduino.cc/en/Reference/StringConstructor>`_\ ()
+-  `charAt <http://arduino.cc/en/Reference/StringCharAt>`_\ ()
+-  `compareTo <http://arduino.cc/en/Reference/StringCompareTo>`_\ ()
+-  `concat <http://arduino.cc/en/Reference/StringConcat>`_\ ()
+-  `endsWith <http://arduino.cc/en/Reference/StringEndsWith>`_\ ()
+-  `equals <http://arduino.cc/en/Reference/StringEquals>`_\ ()
+-  `equalsIgnoreCase <http://arduino.cc/en/Reference/StringEqualsIgnoreCase>`_\ ()
+-  `getBytes <http://arduino.cc/en/Reference/StringGetBytes>`_\ ()
+-  `indexOf <http://arduino.cc/en/Reference/StringIndexOf>`_\ ()
+-  `lastIndexOf <http://arduino.cc/en/Reference/StringLastIndexOf>`_\ ()
+-  `length <http://arduino.cc/en/Reference/StringLength>`_\ ()
+-  `replace <http://arduino.cc/en/Reference/StringReplace>`_\ ()
+-  `setCharAt <http://arduino.cc/en/Reference/StringSetCharAt>`_\ ()
+-  `startsWith <http://arduino.cc/en/Reference/StringStartsWith>`_\ ()
+-  `substring <http://arduino.cc/en/Reference/StringSubstring>`_\ ()
+-  `toCharArray <http://arduino.cc/en/Reference/StringToCharArray>`_\ ()
+-  `toLowerCase <http://arduino.cc/en/Reference/StringToLowerCase>`_\ ()
+-  `toUpperCase <http://arduino.cc/en/Reference/StringToUpperCase>`_\ ()
+-  `trim <http://arduino.cc/en/Reference/StringTrim>`_\ ()
+
+
+
+Operators
+---------
+
+
+-  `[] (element access) <http://arduino.cc/en/Reference/StringBrackets>`_
+-  `+ (concatenation) <http://arduino.cc/en/Reference/StringPlus>`_
+-  `== (comparison) <http://arduino.cc/en/Reference/StringComparison>`_
+
+
+
+Examples
+--------
+
+
+-  `StringConstructors <http://arduino.cc/en/Tutorial/StringConstructors>`_
+-  `StringAdditionOperator <http://arduino.cc/en/Tutorial/StringAdditionOperator>`_
+-  `StringIndexOf <http://arduino.cc/en/Tutorial/StringIndexOf>`_
+-  `StringAppendOperator <http://arduino.cc/en/Tutorial/StringAppendOperator>`_
+-  `StringLengthTrim <http://arduino.cc/en/Tutorial/StringLengthTrim>`_
+-  `StringCaseChanges <http://arduino.cc/en/Tutorial/StringCaseChanges>`_
+-  `StringReplace <http://arduino.cc/en/Tutorial/StringReplace>`_
+-  `StringCharacters <http://arduino.cc/en/Tutorial/StringCharacters>`_
+-  `StringStartsWithEndsWith <http://arduino.cc/en/Tutorial/StringStartsWithEndsWith>`_
+-  `StringComparisonOperators <http://arduino.cc/en/Tutorial/StringComparisonOperators>`_
+-  `StringSubstring <http://arduino.cc/en/Tutorial/StringSubstring>`_
+
+
+
+See Also
+--------
+
+
+-  `Character array strings <http://arduino.cc/en/Reference/String>`_
+-  `Variable Declaration <http://arduino.cc/en/Reference/VariableDeclaration>`_
+
+
+
+
+.. include:: /lang/cc-attribution.txt
-- 
cgit v1.2.3