← Back to branch summary

~ubuntu-branches/ubuntu/wily/sflphone/wily

« back to all changes in this revision

Viewing changes to daemon/libs/pjproject-2.2.1/doc/pjsip-book/breathe.rst

  • Committer: Package Import Robot
  • Author(s): Francois Marier, Francois Marier, Mark Purcell
  • Date: 2014-10-18 15:08:50 UTC
  • mfrom: (1.1.12)
  • mto: This revision was merged to the branch mainline in revision 29.
  • Revision ID: package-import@ubuntu.com-20141018150850-2exfk34ckb15pcwi
Tags: 1.4.1-0.1
http://bugs.debian.org/759576
http://bugs.debian.org/741130
[ Francois Marier ]
* Non-maintainer upload
* New upstream release (closes: #759576, #741130)
  - debian/rules +PJPROJECT_VERSION := 2.2.1
  - add upstream patch to fix broken TLS support
  - add patch to fix pjproject regression

[ Mark Purcell ]
* Build-Depends:
  - sflphone-daemon + libavformat-dev, libavcodec-dev, libswscale-dev,
  libavdevice-dev, libavutil-dev
  - sflphone-gnome + libclutter-gtk-1.0-dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
daemon/libs/pjproject-2.2.1/doc/pjsip-book/breathe.rst
 
1
Appendix: Generating This Documentation
 
2
=======================================
 
3
 
 
4
Requirements
 
5
------------
 
6
 
 
7
This documentation is created with `Sphinx <http://sphinx-doc.org>`_ and `Breathe <http://michaeljones.github.io/breathe/index.html>`_. Here are the required tools:
 
8
 
 
9
1. Doxygen is required. `Install <http://www.stack.nl/~dimitri/doxygen/download.html#srcbin>`_ it for your platform.
 
10
 
 
11
2. The easiest way to install all the tools is with `Python Package Index (PyPI) <http://pypi.python.org>`_. Just run this and it will install Sphinx, Breathe, and all the required tools if they are not installed::
 
12
 
 
13
   $ sudo pip install breathe
 
14
 
 
15
3. Otherwise if PyPI is not available, consult Sphinx and Breathe sites for installation instructions and you may need to install these manually:
 
16
 
 
17
  - `Sphinx <http://sphinx-doc.org>`_
 
18
  - `Breathe <http://michaeljones.github.io/breathe/index.html>`_
 
19
  - docutils
 
20
  - Pygments
 
21
 
 
22
 
 
23
Rendering The Documentation
 
24
------------------------------
 
25
The main source of the documentation is currently the '''Trac''' pages at https://trac.pjsip.org/repos/wiki/pjsip-doc/index. The copies in SVN are just copies for backup.
 
26
 
 
27
To render the documentation as HTML in `_build/html` directory::
 
28
 
 
29
  $ cd $PJDIR/doc/pjsip-book
 
30
  $ python fetch_trac.py
 
31
  $ make
 
32
  
 
33
To build PDF, run::
 
34
 
 
35
  $ make latexpdf
 
36
 
 
37
 
 
38
How to Use Integrate Book with Doxygen
 
39
--------------------------------------
 
40
Quick sample::
 
41
 
 
42
  will be rendered like this:
 
43
  +++++++++++++++++++++++++++
 
44
 
 
45
  This is how to quote a code with syntax coloring:
 
46
 
 
47
  .. code-block:: c++
 
48
 
 
49
       pj::AudioMediaPlayer *player = new AudioMediaPlayer;
 
50
       player->createPlayer("announcement.wav");
 
51
 
 
52
  There are many ways to refer a symbol: 
 
53
 
 
54
  * A method: :cpp:func:`pj::AudioMediaPlayer::createPlayer()`
 
55
  * A method with alternate display: :cpp:func:`a method <pj::AudioMediaPlayer::createPlayer()>`
 
56
  * A class :cpp:class:`pj::AudioMediaPlayer`
 
57
  * A class with alternate display: :cpp:class:`a class <pj::AudioMediaPlayer>`
 
58
 
 
59
  For that links to work, we need to display the link target declaration (a class or method) 
 
60
  somewhere in the doc, like this:
 
61
  
 
62
  .. doxygenclass:: pj::AudioMediaPlayer
 
63
        :path: xml
 
64
        :members:
 
65
 
 
66
  Alternatively we can display a single method declaration like this:
 
67
 
 
68
  .. doxygenfunction:: pj::AudioMediaPlayer::createPlayer()
 
69
        :path: xml
 
70
        :no-link:
 
71
 
 
72
  We can also display class declaration with specific members.
 
73
  
 
74
  For more info see `Breathe documentation <http://michaeljones.github.io/breathe/domains.html>`_
 
75
 
 
76
     
 
77
.. default-domain:: cpp
 
78
 
 
79
will be rendered like this:
 
80
+++++++++++++++++++++++++++
 
81
 
 
82
This is how to quote a code with syntax coloring:
 
83
 
 
84
.. code-block:: c++
 
85
 
 
86
       pj::AudioMediaPlayer *player = new AudioMediaPlayer;
 
87
       player->createPlayer("announcement.wav");
 
88
 
 
89
There are many ways to refer a symbol: 
 
90
 
 
91
* A method: :cpp:func:`pj::AudioMediaPlayer::createPlayer()`
 
92
* A method with alternate display: :cpp:func:`a method <pj::AudioMediaPlayer::createPlayer()>`
 
93
* A class :cpp:class:`pj::AudioMediaPlayer`
 
94
* A class with alternate display: :cpp:class:`a class <pj::AudioMediaPlayer>`
 
95
 
 
96
For that links to work, we need to display the link target declaration (a class or method) somewhere in the doc, like this:
 
97
  
 
98
   .. doxygenclass:: pj::AudioMediaPlayer
 
99
        :path: xml
 
100
        :members:
 
101
 
 
102
Alternatively we can display a single method declaration like this:
 
103
 
 
104
   .. doxygenfunction:: pj::AudioMediaPlayer::createPlayer()
 
105
        :path: xml
 
106
        :no-link:
 
107
 
 
108
We can also display class declaration with specific members.
 
109
 
 
110
For more info see `Breathe documentation <http://michaeljones.github.io/breathe/domains.html>`_
 
111
 
 
112
 
 
113