Skip to content

Commit

Permalink
Fix documentation warnings.
Browse files Browse the repository at this point in the history
  • Loading branch information
neXyon committed Apr 30, 2020
1 parent 7a6054f commit 8e5e2e6
Show file tree
Hide file tree
Showing 9 changed files with 13 additions and 21 deletions.
1 change: 1 addition & 0 deletions bindings/doc/device.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@ Device
.. currentmodule:: aud
.. autoclass:: Device
:members:
:noindex:

1 change: 1 addition & 0 deletions bindings/doc/handle.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@ Handle
.. currentmodule:: aud
.. autoclass:: Handle
:members:
:noindex:

3 changes: 2 additions & 1 deletion bindings/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Welcome to audaspace's documentation!
=====================================

.. automodule:: aud
:no-members:

This documentation is valid for both the Python and C bindings of audaspace. If you are looking for installation instructions check the `C++ API documentation <../index.html>`_. As C is not an object oriented language everything is accessible via functions where the first paramter is always the object. For methods these are named as ``AUD_ClassName_method()`` and properties are accessed via ``AUD_ClassName_property_get/set()``. Python users simply ``import aud`` to access the library.

Expand All @@ -18,7 +19,7 @@ This documentation is valid for both the Python and C bindings of audaspace. If
Classes:

.. toctree::
:maxdepth: 2
:maxdepth: 1

device
sound
Expand Down
1 change: 1 addition & 0 deletions bindings/doc/sequence.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@ Sequence
.. currentmodule:: aud
.. autoclass:: Sequence
:members:
:noindex:

1 change: 1 addition & 0 deletions bindings/doc/sequence_entry.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@ Sequence Entry
.. currentmodule:: aud
.. autoclass:: SequenceEntry
:members:
:noindex:

1 change: 1 addition & 0 deletions bindings/doc/sound.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@ Sound
.. currentmodule:: aud
.. autoclass:: Sound
:members:
:noindex:

2 changes: 1 addition & 1 deletion bindings/doc/tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ and create a :func:`aud.Sound.sine` signal with a frequency of 440 Hz.
sine = aud.Sound.sine(440)
.. note:: At this point nothing is playing back yet,
:class:`aud.Sound` objects are just descriptions of sounds.
:class:`aud.Sound` objects are just descriptions of sounds.

However instead of a sine wave, we would like to have a square wave
to produce a more retro gaming sound. We could of course use the
Expand Down
9 changes: 5 additions & 4 deletions bindings/python/PySound.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1394,7 +1394,7 @@ PyDoc_STRVAR(M_aud_Sound_threshold_doc,
" with a amplitude >= threshold to 1, all <= -threshold to -1 and\n"
" all between to 0.\n\n"
" :arg threshold: Threshold value over which an amplitude counts\n"
" non-zero.\n"
" non-zero.\n\n"
":type threshold: float\n"
":return: The created :class:`Sound` object.\n"
":rtype: :class:`Sound`");
Expand Down Expand Up @@ -1434,7 +1434,8 @@ PyDoc_STRVAR(M_aud_Sound_volume_doc,
" :type volume: float\n"
" :return: The created :class:`Sound` object.\n"
" :rtype: :class:`Sound`\n\n"
" .. note:: Should be in the range [0, 1] to avoid clipping.\n\n"
" .. note::\n\n"
" Should be in the range [0, 1] to avoid clipping.\n\n"
" .. note::\n\n"
" This is a filter function, you might consider using\n"
" :attr:`Handle.volume` instead.");
Expand Down Expand Up @@ -1475,8 +1476,8 @@ PyDoc_STRVAR(M_aud_Sound_join_doc,
" :return: The created :class:`Sound` object.\n"
" :rtype: :class:`Sound`\n\n"
" .. note::\n\n"
" The two factories have to have the same specifications\n"
" (channels and samplerate).");
" The two factories have to have the same specifications\n"
" (channels and samplerate).");

static PyObject *
Sound_join(Sound* self, PyObject* object)
Expand Down
15 changes: 0 additions & 15 deletions doc/Doxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -2025,12 +2025,6 @@ EXTERNAL_GROUPS = YES

EXTERNAL_PAGES = YES

# The PERL_PATH should be the absolute path and name of the perl script
# interpreter (i.e. the result of 'which perl').
# The default file (with absolute path) is: /usr/bin/perl.

PERL_PATH = /usr/bin/perl

#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
Expand All @@ -2044,15 +2038,6 @@ PERL_PATH = /usr/bin/perl

CLASS_DIAGRAMS = YES

# You can define message sequence charts within doxygen comments using the \msc
# command. Doxygen will then run the mscgen tool (see:
# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
# the mscgen tool resides. If left empty the tool is assumed to be found in the
# default search path.

MSCGEN_PATH =

# You can include diagrams made with dia in doxygen documentation. Doxygen will
# then run dia to produce the diagram and insert it in the documentation. The
# DIA_PATH tag allows you to specify the directory where the dia binary resides.
Expand Down

0 comments on commit 8e5e2e6

Please sign in to comment.