Commit Graph

116 Commits

Author SHA1 Message Date
xuxuehai
582d7b6130 commit msg
Signed-off-by: xuxuehai <xuxuehai2@huawei.com>
2024-05-16 17:35:05 +08:00
Jaroslav Kysela
2623e4bb76 ucm: add initial doxygen documenation
This is an attempt to explain the UCM in a more verbose way.

BugLink: https://github.com/alsa-project/alsa-ucm-conf/issues/103
Signed-off-by: Jaroslav Kysela <perex@perex.cz>
2021-12-01 10:33:44 +01:00
Jaroslav Kysela
7371ac9aad control: doc - create controls plugin page
Signed-off-by: Jaroslav Kysela <perex@perex.cz>
2021-04-07 16:24:05 +02:00
Takashi Iwai
5eb8ae1bb0 doxygen: Suppress timestamp
The build timestamp in the doc is bad for packaging in general, so
let's disable it as default.

Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-06-23 16:29:07 +02:00
Liam Girdwood
22603237b0 topology: doxygen: Add doxygen support for topology core.
Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2015-07-30 17:10:18 +02:00
Liam Girdwood
c6df827374 docs: Add UCM link to main doxygen page.
Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2015-06-29 17:44:10 +02:00
Liam Girdwood
f66c7cc293 ucm: docs: fix doxygen exclude patch for UCM local header
Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2015-06-29 17:43:50 +02:00
Patrick Welche
b669b50de2 autotools: update style
- rename configure.in to configure.ac
- replace INCLUDES with AM_CPPFLAGS
- modernize AM_INIT_AUTOMAKE invocation

Signed-off-by: Patrick Welche <prlw1@cam.ac.uk>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2014-02-26 08:16:22 +01:00
Jaroslav Kysela
b6eb0f9bfd all places: doxygen cleanups
I see no errors with these changes using doxygen 1.8.1.1 .

Signed-off-by: Jaroslav Kysela <perex@perex.cz>
2013-04-08 16:42:24 +02:00
Jaroslav Kysela
a074588889 doc: Use 'rm -rf' for the html doxygen tree (it contains search/ dir now)
Signed-off-by: Jaroslav Kysela <perex@perex.cz>
2012-09-06 10:53:14 +02:00
Jaroslav Kysela
1c79fad969 ucm: Moved ucm to src/ucm subdirectory
- separate code to more files
- use standard lists to represent structures
- use alsa-lib configuration parser

Signed-off-by: Jaroslav Kysela <perex@perex.cz>
2010-09-15 08:09:31 +02:00
Liam Girdwood
1c5afdb0c1 ucm: build - add build support for Use Case Manager
Add doxygen and make support for UCM.

CC: Mark Brown <broonie@opensource.wolfsonmicro.com>
Signed-off-by: Justin Xu <justinx@slimlogic.co.uk>
Signed-off-by: Stefan Schmidt <stefan@slimlogic.co.uk>
Signed-off-by: Liam Girdwood <lrg@slimlogic.co.uk>
2010-08-23 20:05:45 +02:00
Clemens Ladisch
0ed67883af doc: hide structs with typedefs
In the documentation, hide structure types that have a corresponding
typedef.  Since doxygen 1.5.4, this is no longer the default when
OPTIMIZE_OUTPUT_FOR_C is set.

Signed-off-by: Clemens Ladisch <clemens@ladisch.de>
2009-08-04 09:15:40 +02:00
Clemens Ladisch
1b4dedc62e doc: fix handling of @top_srcdir@
The value of top_srcdir should be replaced in the config file, not in
the makefile, so we have to escape it in the makefile.

In the default case, the value of top_srcdir is ".." which, when used as
a regular expression, is a little bit too inclusive.

Signed-off-by: Clemens Ladisch <clemens@ladisch.de>
2009-08-04 09:12:39 +02:00
Takashi Iwai
6ab63388d1 Create doxgen.cfg dynamically
The patch from bug#3799
	https://bugtrack.alsa-project.org/alsa-bug/view.php?id=3799

The "doc" target in doc/Makefile.am assumes the build directory and
the source directory are the same and fails if they differ ... this is
because the doxygen.cfg contains relative paths (such as ../) that
only work when building in the source tree

The attached patch against hg replaces all relative paths with
@top_srcdir@ and changes doxygen.cfg to a generated file so that
configure replaces @top_srcdir@ with the appropriate configure-time
path.

Assuming people like being able to do `make -f Makefile.am doc` on
an unconfigured and having it work, i added a small `test&&sed`
that'll generate an appropriate default doxygen.cfg for them.
2008-02-25 14:56:51 +01:00
Takashi Iwai
d902c124b4 Remove obsolete instr directory 2008-01-23 08:06:11 +01:00
Takashi Iwai
54a2cf5ecf Remove sequencer instrument layer
Remove obsoleted sequencer instrument layer from alsa-lib.
The old symbols are compiled in as default as dummy functions
(unless --disable-old-symbols is given to configure) so that
the old binaries can still work more or less.
2007-10-30 12:31:55 +01:00
Jaroslav Kysela
d25e281230 Changed Jaroslav Kysela's e-mail from perex@suse.cz to perex@perex.cz 2007-10-15 10:24:55 +02:00
Takashi Iwai
686a32c61f Add the missing include/mixer.h to doxygen.cfg 2007-08-22 14:24:58 +02:00
Takashi Iwai
b72b817df6 Add missing pcm_empty.c in doxygen configuration 2007-08-10 17:41:49 +02:00
Takashi Iwai
4cdb17c601 Split mmap-emulation code from hw layer
Move out mmap-emulation code from hw layer to its own plugin.
This cleans up the mess in pcm_hw.c.
2007-07-11 17:44:09 +02:00
Jaroslav Kysela
13fdc41785 add snd_device_name_hint() function and initial implementation
- add snd_device_name_hint() and snd_device_name_free_hint() functions
- add snd_ctl_iface_conf_name() functions
- do not accept parameters for the plugin definition without @args section
- add defaults.pcm.dmix.card/device and dsnoop.card/device definitions
- add hints for HDA-Intel.conf, pcm/dmix.conf, pcm/dsnoop.conf and alsa.conf
- add test/namehint test utility
- doxygen related cleanups
2006-10-11 13:18:57 +02:00
Jaroslav Kysela
91273c228f Fix examples for PCM API. Fix dogygen warnings. 2006-07-11 21:48:51 +02:00
Takashi Iwai
3656a66397 Add detailed documentation for external control plugin SDK
Added the detailed documentation for external control plugin SDK.
2005-06-13 13:19:03 +00:00
Jaroslav Kysela
4c4849230c initial & empty smixer-ac97.so module (only the build framework) 2005-06-07 11:44:25 +00:00
Takashi Iwai
270da603fd Add description for perm option of file plugin
Added the description for the new "perm" option of file plugin.
2005-05-30 17:03:00 +00:00
Jaroslav Kysela
02b6b9f616 Corrected ipc_gid 2005-05-30 11:36:27 +00:00
Jaroslav Kysela
d5e434c427 Added ipc_gid 2005-05-30 11:35:44 +00:00
Takashi Iwai
087184b0f9 Fix doxygen documents
Fix the warnings of doxygen parsing.
Add some missing documentation.
2005-05-24 14:14:28 +00:00
Takashi Iwai
7651690858 Fix documentation of external PCM plugin SDK
Fix documentation of external PCM plugin SDK.
2005-05-24 09:42:01 +00:00
Takashi Iwai
c5fc9e7cf7 Add external PCM plugin
Added the section for external PCM plugin.
2005-04-14 15:29:57 +00:00
Takashi Iwai
227441b2c8 More doxygen comments
Added more doxygen comments in pcm_extplug and pcm_ioplug codes.
2005-03-09 11:54:58 +00:00
Takashi Iwai
30f35c1f7a Add softvol PCM plugin
The softvol PCM plugin is added.  It applies the software volume attenuation,
which may be useful for codecs without volume controls.

Currently, the control is only mono.  The attenuation is applied to all
channels equally.  The control is probed and automatically created
when not exists yet.
2004-12-27 14:40:19 +00:00
Jaroslav Kysela
43190ac973 Summay: Added doc-pack and doc-clean rules 2004-09-07 09:43:31 +00:00
Takashi Iwai
c11a1fc9be fixed documents to process properly via doxygen. 2004-05-24 14:57:47 +00:00
Clemens Ladisch
16a15f56c4 fix doxygen errors (syntax errors and wrong references) 2004-03-02 17:13:49 +00:00
Takashi Iwai
b833982c70 - added asym plugin. 2004-01-08 14:05:55 +00:00
Takashi Iwai
321968faed - new e-mail address of Frank van de Pol. 2004-01-07 14:36:39 +00:00
Jaroslav Kysela
0545cf711d Maik Broemme <mbroemme@plusserver.de>
- added ipc_perm for dmix plugin
Jaroslav Kysela <perex@suse.cz>
- added ipc_perm for dsnoop and dshare plugins
- added ipc_perm to doc/asoundrc.txt
2003-12-07 09:30:47 +00:00
Takashi Iwai
7714346bc2 added pcm_d* files. 2003-03-26 15:24:19 +00:00
Jaroslav Kysela
ead9960abc Added dsnoop and dshare plugins 2003-03-19 16:38:43 +00:00
Jaroslav Kysela
cfe6f7be54 Added bindings to dmix plugin 2003-03-18 17:08:38 +00:00
Jaroslav Kysela
9ccf002f54 Added 32-bit sample support to dmix plugin 2003-03-18 14:15:19 +00:00
Jaroslav Kysela
a8f375386e Added more example for dmix plugin 2003-03-01 09:05:31 +00:00
Jaroslav Kysela
6e3c42dadd Added dmix plugin 2003-02-12 15:20:38 +00:00
Jaroslav Kysela
7f3942d827 Reverted back the PCM API.
New snd_pcm_hw_params_* functions are available only explicitly when
ALSA_PCM_NEW_HW_PARAMS_API is defined.
Updated documentation and test code to new API.
2002-09-19 16:12:13 +00:00
Jaroslav Kysela
63d708a344 Documentation update by Clement Ladish 2002-07-23 19:51:16 +00:00
Jaroslav Kysela
48f6b71f41 Added pictures to EXTRA_DIST 2002-03-09 17:36:37 +00:00
Jaroslav Kysela
1bd2ac6dd4 Added pictures for PCM intro 2002-02-13 23:19:03 +00:00
Jaroslav Kysela
2ca5ace9cb More documentation changes (rawmidi, timer) 2002-02-11 18:11:16 +00:00