Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
What's new
7
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Open sidebar
Xiph.Org
aom-rav1e
Commits
011be1af
Commit
011be1af
authored
Feb 18, 2014
by
James Zern
Committed by
Gerrit Code Review
Feb 18, 2014
Browse files
Options
Browse Files
Download
Plain Diff
Merge "restore examples to doxygen output"
parents
89ec9904
354c5660
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
35 additions
and
0 deletions
+35
-0
docs.mk
docs.mk
+2
-0
examples.mk
examples.mk
+33
-0
No files found.
docs.mk
View file @
011be1af
...
...
@@ -30,7 +30,9 @@ TXT_DOX = $(call enabled,TXT_DOX)
EXAMPLE_PATH
+=
$(SRC_PATH_BARE)
#for CHANGELOG, README, etc
EXAMPLE_PATH
+=
$(SRC_PATH_BARE)
/examples
doxyfile
:
$(if $(findstring examples
,
$(ALL_TARGETS))
,
examples.doxy)
doxyfile
:
libs.doxy_template libs.doxy
@
echo
" [CREATE]
$@
"
@
cat
$^
>
$@
...
...
examples.mk
View file @
011be1af
...
...
@@ -285,3 +285,36 @@ INSTALL-BINS-$(CONFIG_MSVS) += $(foreach p,$(VS_PLATFORMS),\
$(
addprefix
bin/
$(p)
/,
$(ALL_EXAMPLES_BASENAME:.c=.exe)
))
$(foreach
proj,$(call
enabled,PROJECTS),\
$(eval
$(call
vcproj_template,$(proj))))
#
# Documentation Rules
#
%.dox
:
%.c
@
echo
" [DOXY]
$@
"
@
echo
"/*!
\p
age example_
$
(@F:.dox=)
$
(@F:.dox=)"
>
$@
@
echo
"
\i
ncludelineno
$
(<F)"
>>
$@
@
echo
"*/"
>>
$@
samples.dox
:
examples.mk
@
echo
" [DOXY]
$@
"
@
echo
"/*!
\p
age samples Sample Code"
>
$@
@
echo
" This SDK includes a number of sample applications."
\
"Each sample documents a feature of the SDK in both prose"
\
"and the associated C code."
\
"The following samples are included: "
>>
$@
@
$(
foreach
ex,
$(
sort
$(
notdir
$(EXAMPLES:.c=)
))
,
\
echo
" -
\s
ubpage example_
$(ex)
$
(
$(ex)
.DESCRIPTION
)
"
>>
$@
;
)
@
echo
>>
$@
@
echo
" In addition, the SDK contains a number of utilities."
\
"Since these utilities are built upon the concepts described"
\
"in the sample code listed above, they are not documented in"
\
"pieces like the samples are. Their source is included here"
\
"for reference. The following utilities are included:"
>>
$@
@
$(
foreach
ex,
$(
sort
$(UTILS:.c=)
)
,
\
echo
" -
\s
ubpage example_
$(ex)
$
(
$(ex)
.DESCRIPTION
)
"
>>
$@
;
)
@
echo
"*/"
>>
$@
CLEAN-OBJS
+=
examples.doxy samples.dox
$(ALL_EXAMPLES:.c=.dox)
DOCS-yes
+=
examples.doxy samples.dox
examples.doxy
:
samples.dox $(ALL_EXAMPLES:.c=.dox)
@
echo
"INPUT +=
$^
"
>
$@
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment