Merge branch 'master' of http://github.com/eProsima/Fast-RTPS-docs

Makefile

@@ -10,9 +10,9 @@ BUILDDIR      = build
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4
 PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) docs
 # the i18n builder cannot share the environment and doctrees with the others
-I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) docs
 
 .PHONY: help
 help:

docs/index.rst

@@ -61,7 +61,6 @@ This documentation is organized into the following sections:
    :caption: FastRTPSGen Manual
 
    geninfo
-   gencompile
    genuse
 
 
@@ -74,6 +73,3 @@ This documentation is organized into the following sections:
    version120.rst
 
 
-
-
-

docs/introduction.rst

@@ -28,7 +28,9 @@ By choosing Quality of Service policies, you can affect how these history caches
 Building your first application
 -------------------------------
 
-To build a minimal application, you must first define the topic. Write an IDL file containing the specification you want. In this case, a single string is sufficient. ::
+To build a minimal application, you must first define the topic. Write an IDL file containing the specification you want. In this case, a single string is sufficient.
+
+.. code-block:: idl
 
     // HelloWorld.idl
     struct HelloWorld
@@ -67,7 +69,9 @@ Each time you press <Enter\> on the Publisher, a new datagram is generated, sent
 and receiver by Subscribers currently online. If more than one subscriber is available, it can be seen that the
 message is equally received on all listening nodes.
 
-You can modify any values on your custom, IDL-generated data type before sending. ::
+You can modify any values on your custom, IDL-generated data type before sending.
+
+.. code-block:: c++
 
         HelloWorld myHelloWorld;
         myHelloWorld.message("HelloWorld");

docs/list.rst

@@ -9,21 +9,21 @@ Publisher Subscriber Module
 
 This module composes the Publisher-Subscriber abstraction we saw in the Library Overview. The concepts here are higher level than the RTPS standard. 
 
-* Domain: Used to create, manage and destroy high-level Participants.
-* Participant: Contains Publishers and Subscribers, and manages their configuration.
+* :class:`Domain` Used to create, manage and destroy high-level Participants.
+* :class:`Participant` Contains Publishers and Subscribers, and manages their configuration.
 
-        * ParticipantAttributes: Configuration parameters used in the creation of a Participant.
-	* ParticipantListener: Allows you to implement callbacks within scope of the Participant.
+    * :class:`ParticipantAttributes` Configuration parameters used in the creation of a Participant.
+    * :class:`ParticipantListener` Allows you to implement callbacks within scope of the Participant.
 
-* Publisher: Sends (publishes) data in the form of topic changes.
+* :class:`Publisher` Sends (publishes) data in the form of topic changes.
 
-        * PublisherAttributes: Configuration parameters for the construction of a Publisher.
-	* PublisherListener: Allows you to implement callbacks within scope of the Publisher.
+    * :class:`PublisherAttributes` Configuration parameters for the construction of a Publisher.
+    * :class:`PublisherListener` Allows you to implement callbacks within scope of the Publisher.
 
-* Subscriber: Receives data for the topics it subscribes to.
+* :class:`Subscriber` Receives data for the topics it subscribes to.
 
-        * SubscriberAttributes: Configuration parameters for the construction of a Subscriber.
-	* SubscriberListener: Allows you to implement callbacks within scope of the Subscriber.
+    * :class:`SubscriberAttributes` Configuration parameters for the construction of a Subscriber.
+    * :class:`SubscriberListener` Allows you to implement callbacks within scope of the Subscriber.
 
 RTPS Module
 -----------
@@ -33,40 +33,40 @@ This module directly maps to the ideas defined in the RTPS standard, and allows
 RTPS Common
 ^^^^^^^^^^^
 
-* CacheChange_t: Represents a change to a topic, to be stored in a history cache.
-* Data: Payload associated to a cache change. May be empty depending on the message and change type.
-* Message: Defines the organization of a RTPS Message.
-* Header: Standard header that identifies a message as belonging to the RTPS protocol, and includes the vendor id.
-* Sub-Message Header: Identifier for an RTPS sub-message. An RTPS Message can be composed of several sub-messages.
-* MessageReceiver: Deserializes and processes received RTPS messages.
-* RTPSMessageCreator: Composes RTPS messages.
+* :class:`CacheChange_t` Represents a change to a topic, to be stored in a history cache.
+* :class:`Data` Payload associated to a cache change. May be empty depending on the message and change type.
+* :class:`Message` Defines the organization of a RTPS Message.
+* :class:`Header` Standard header that identifies a message as belonging to the RTPS protocol, and includes the vendor id.
+* :class:`Sub-Message Header` Identifier for an RTPS sub-message. An RTPS Message can be composed of several sub-messages.
+* :class:`MessageReceiver` Deserializes and processes received RTPS messages.
+* :class:`RTPSMessageCreator` Composes RTPS messages.
 
 RTPS Domain
 ^^^^^^^^^^^
 
-* RTPSDomain: Use it to create, manage and destroy low-level RTPSParticipants.
-* RTPSParticipant: Contains RTPS Writers and Readers, and manages their configuration.
-	
-        * RTPSParticipantAttributes: Configuration parameters used in the creation of an RTPS Participant.
-	* PDPSimple: Allows the participant to become aware of the other participants within the Network, through the Participant Discovery Protocol.
-	* EDPSimple: Allows the Participant to become aware of the endpoints (RTPS Writers and Readers) present in the other Participants within the network, through the Endpoint Discovery Protocol.
-	* EDPStatic: Reads information about remote endpoints from a user file.
-	* TimedEvent:  Base class for periodic or timed events.
+* :class:`RTPSDomain` Use it to create, manage and destroy low-level RTPSParticipants.
+* :class:`RTPSParticipant` Contains RTPS Writers and Readers, and manages their configuration.
+
+    * :class:`RTPSParticipantAttributes` Configuration parameters used in the creation of an RTPS Participant.
+    * :class:`PDPSimple` Allows the participant to become aware of the other participants within the Network, through the Participant Discovery Protocol.
+    * :class:`EDPSimple` Allows the Participant to become aware of the endpoints (RTPS Writers and Readers) present in the other Participants within the network, through the Endpoint Discovery Protocol.
+    * :class:`EDPStatic` Reads information about remote endpoints from a user file.
+    * :class:`TimedEvent`  Base class for periodic or timed events.
 
 RTPS Reader
 ^^^^^^^^^^^
 
-* RTPSReader: Base class for the reader endpoint. 
-	
-        * ReaderAttributes: Configuration parameters used in the creation of an RTPS Reader.
-	* ReaderHistory: History data structure. Stores recent topic changes.
-	* ReaderListener: Use it to define callbacks in scope of the Reader.
+* :class:`RTPSReader` Base class for the reader endpoint. 
+
+    * :class:`ReaderAttributes` Configuration parameters used in the creation of an RTPS Reader.
+    * :class:`ReaderHistory` History data structure. Stores recent topic changes.
+    * :class:`ReaderListener` Use it to define callbacks in scope of the Reader.
 
 RTPS Writer
 ^^^^^^^^^^^
 
-* RTPSWriter: Base class for the writer endpoint.
-	        
-        * WriterAttributes: Configuration parameters used in the creation of an RTPS Writer.
-	* WriterHistory: History data structure. Stores outgoing topic changes and schedules them to be sent.
+* :class:`RTPSWriter` Base class for the writer endpoint.
+
+    * :class:`WriterAttributes` Configuration parameters used in the creation of an RTPS Writer.
+    * :class:`WriterHistory` History data structure. Stores outgoing topic changes and schedules them to be sent.