diff options
| author | Danielle Madeley <danielle.madeley@collabora.co.uk> | 2011-04-21 09:11:21 +1000 |
|---|---|---|
| committer | Danielle Madeley <danielle.madeley@collabora.co.uk> | 2011-04-21 09:11:21 +1000 |
| commit | 838b2c1c8f406f7b306cad35b253f44ba6da775c (patch) | |
| tree | 832761db335c2ec8d5e50bbed0477d07edeeb795 | |
| parent | 14345ebf68847d66b09c693472650c7ff3f5872c (diff) | |
Add more docstrings
| -rw-r--r-- | spec/Channel_Interface_SMS.xml | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/spec/Channel_Interface_SMS.xml b/spec/Channel_Interface_SMS.xml index 872a1618..82bd7d44 100644 --- a/spec/Channel_Interface_SMS.xml +++ b/spec/Channel_Interface_SMS.xml @@ -221,6 +221,10 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. This method allows the client, without any knowledge of the encoding mechanism to provide length details to the user.</p> </tp:rationale> + + <p>Clients SHOULD limit the frequency with which this method is called + and SHOULD NOT call it for every keystroke. Clients MAY estimate the + remaining size between single keystrokes.</p> </tp:docstring> <arg name="Content" type="s" direction="in"> @@ -264,7 +268,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. </arg> <tp:possible-errors> - <tp:error name="org.freedesktop.Telepathy.Error.NotImplemented"/> + <tp:error name="org.freedesktop.Telepathy.Error.NotImplemented"> + <tp:docstring> + Raised when the method is not available on this channel. + Clients MAY choose to make their own estimation. + </tp:docstring> + </tp:error> <tp:error name="org.freedesktop.Telepathy.Error.InvalidArgument"> <tp:docstring> Raised when the content cannot be encoded into a valid SMS. |