Move api documentation to a separate folder.

This commit is contained in:
tisto
2012-01-25 23:06:42 +01:00
committed by Timo Stollenwerk
parent 7d34baf2d5
commit 65590732ea
7 changed files with 31 additions and 13 deletions
+1
View File
@@ -0,0 +1 @@
.. include:: ../../../plone/app/discussion/comment.txt
+1
View File
@@ -0,0 +1 @@
.. include:: ../../../plone/app/discussion/conversation.txt
+21
View File
@@ -0,0 +1,21 @@
===
API
===
The conversation and replies adapters.
The conversation is responsible for storing all comments. It provides a
dict-like API for accessing comments, where keys are integers and values
are IComment objects. It also provides features for finding comments quickly.
The IReplies adapter provides an API for finding and manipulating the comments
directly in reply to a particular comment (implemented by the CommentReplies
adpater) or at the top level of the conversation (implemented by the
ConversationReplies adapter).
.. toctree::
:maxdepth: 1
conversation.txt
comment.txt