Mesa (master): doxygen: Generate Doxygen for NIR
Emil Velikov
evelikov at kemper.freedesktop.org
Wed Apr 13 12:44:00 UTC 2016
Module: Mesa
Branch: master
Commit: f04565c876b7d04a50da60ce658b2cc00dd5a140
URL: http://cgit.freedesktop.org/mesa/mesa/commit/?id=f04565c876b7d04a50da60ce658b2cc00dd5a140
Author: Elie TOURNIER <tournier.elie at gmail.com>
Date: Sat Apr 9 15:48:13 2016 +0200
doxygen: Generate Doxygen for NIR
Now, one can do the following to generate and read the nir Doxygen:
cd $MESA_TOP/doxygen
make
firefox nir/index.html
Update v2:
Correct TAGFILES in nir.doxy
Signed-off-by: Elie TOURNIER <tournier.elie at gmail.com>
Reviewed-by: Rhys Kidd <rhyskidd at gmail.com>
[Emil Velikov] v3: Rebase.
Signed-off-by: Emil Velikov <emil.velikov at collabora.com>
---
doxygen/.gitignore | 1 +
doxygen/Makefile | 3 ++-
doxygen/Makefile.orig | 35 +++++++++++++++++++++++++++++++++
doxygen/header.html | 1 +
doxygen/header.html.orig | 19 ++++++++++++++++++
doxygen/nir.doxy | 50 ++++++++++++++++++++++++++++++++++++++++++++++++
6 files changed, 108 insertions(+), 1 deletion(-)
diff --git a/doxygen/.gitignore b/doxygen/.gitignore
index ea67dd5..4773413 100644
--- a/doxygen/.gitignore
+++ b/doxygen/.gitignore
@@ -10,6 +10,7 @@ i965
main
math
math_subset
+nir
radeon_subset
swrast
swrast_setup
diff --git a/doxygen/Makefile b/doxygen/Makefile
index b1bc15d..6685b99 100644
--- a/doxygen/Makefile
+++ b/doxygen/Makefile
@@ -17,7 +17,8 @@ FULL = \
tnl.doxy \
tnl_dd.doxy \
gbm.doxy \
- i965.doxy
+ i965.doxy \
+ nir.doxy
full: $(FULL:.doxy=.tag)
$(foreach FILE,$(FULL),doxygen $(FILE);)
diff --git a/doxygen/Makefile.orig b/doxygen/Makefile.orig
new file mode 100644
index 0000000..b1bc15d
--- /dev/null
+++ b/doxygen/Makefile.orig
@@ -0,0 +1,35 @@
+
+default: full
+
+all: full subset
+
+%.tag: %.doxy
+ doxygen $<
+
+FULL = \
+ main.doxy \
+ math.doxy \
+ vbo.doxy \
+ glapi.doxy \
+ glsl.doxy \
+ swrast.doxy \
+ swrast_setup.doxy \
+ tnl.doxy \
+ tnl_dd.doxy \
+ gbm.doxy \
+ i965.doxy
+
+full: $(FULL:.doxy=.tag)
+ $(foreach FILE,$(FULL),doxygen $(FILE);)
+
+SUBSET = \
+ main.doxy \
+ math.doxy
+
+subset: $(SUBSET:.doxy=.tag)
+ $(foreach FILE,$(SUBSET),doxygen $(FILE);)
+
+clean:
+ -rm -rf $(FULL:.doxy=) $(SUBSET:.doxy=)
+ -rm -rf *.tag
+ -rm -rf *.db
diff --git a/doxygen/header.html b/doxygen/header.html
index 034231c..9f12b58 100644
--- a/doxygen/header.html
+++ b/doxygen/header.html
@@ -8,6 +8,7 @@
<a class="qindex" href="../main/index.html">core</a> |
<a class="qindex" href="../glapi/index.html">glapi</a> |
<a class="qindex" href="../glsl/index.html">glsl</a> |
+<a class="qindex" href="../nir/index.html">nir</a> |
<a class="qindex" href="../vbo/index.html">vbo</a> |
<a class="qindex" href="../math/index.html">math</a> |
<a class="qindex" href="../swrast/index.html">swrast</a> |
diff --git a/doxygen/header.html.orig b/doxygen/header.html.orig
new file mode 100644
index 0000000..034231c
--- /dev/null
+++ b/doxygen/header.html.orig
@@ -0,0 +1,19 @@
+<html>
+<head>
+<title>Mesa Source Code Documentation</title>
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head>
+<body>
+<div class="qindex">
+<a class="qindex" href="../main/index.html">core</a> |
+<a class="qindex" href="../glapi/index.html">glapi</a> |
+<a class="qindex" href="../glsl/index.html">glsl</a> |
+<a class="qindex" href="../vbo/index.html">vbo</a> |
+<a class="qindex" href="../math/index.html">math</a> |
+<a class="qindex" href="../swrast/index.html">swrast</a> |
+<a class="qindex" href="../swrast_setup/index.html">swrast_setup</a> |
+<a class="qindex" href="../tnl/index.html">tnl</a> |
+<a class="qindex" href="../tnl_dd/index.html">tnl_dd</a> |
+<a class="qindex" href="../gbm/index.html">gbm</a> |
+<a class="qindex" href="../i965/index.html">i965</a>
+</div>
diff --git a/doxygen/nir.doxy b/doxygen/nir.doxy
new file mode 100644
index 0000000..cad7380
--- /dev/null
+++ b/doxygen/nir.doxy
@@ -0,0 +1,50 @@
+# Doxyfile 0.1
+
+ at INCLUDE = common.doxy
+
+#---------------------------------------------------------------------------
+# General configuration options
+#---------------------------------------------------------------------------
+PROJECT_NAME = "Mesa NIR module"
+#---------------------------------------------------------------------------
+# Configuration options related to the input files
+#---------------------------------------------------------------------------
+INPUT = ../src/compiler/nir
+FILE_PATTERNS = *.c *.cpp *.h
+RECURSIVE = NO
+EXCLUDE =
+EXCLUDE_PATTERNS =
+EXAMPLE_PATH =
+EXAMPLE_PATTERNS =
+EXAMPLE_RECURSIVE = NO
+IMAGE_PATH =
+INPUT_FILTER =
+FILTER_SOURCE_FILES = NO
+#---------------------------------------------------------------------------
+# Configuration options related to the HTML output
+#---------------------------------------------------------------------------
+HTML_OUTPUT = nir
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+ENABLE_PREPROCESSING = YES
+MACRO_EXPANSION = NO
+EXPAND_ONLY_PREDEF = NO
+SEARCH_INCLUDES = YES
+INCLUDE_PATH = ../include/
+INCLUDE_FILE_PATTERNS =
+PREDEFINED =
+EXPAND_AS_DEFINED =
+SKIP_FUNCTION_MACROS = YES
+#---------------------------------------------------------------------------
+# Configuration::additions related to external references
+#---------------------------------------------------------------------------
+TAGFILES = glsl.tag=../glsl \
+ main.tag=../main \
+ math.tag=../math \
+ swrast.tag=../swrast \
+ swrast_setup.tag=../swrast_setup \
+ tnl.tag=../tnl \
+ tnl_dd.tag=../tnl_dd \
+ vbo.tag=../vbo
+GENERATE_TAGFILE = nir.tag
More information about the mesa-commit
mailing list