[Mesa-dev] [PATCH] doxygen: Generate Doxygen for NIR

[Rhys Kidd]

Hello Elie,

On 9 April 2016 at 08:50, Elie TOURNIER <tournier.elie at gmail.com> wrote:

> Now, one can do the following to generate and read the nir Doxygen:
> cd $MESA_TOP/doxygen
> make
> firefox nir/index.html
>
> Signed-off-by: Elie TOURNIER <tournier.elie at gmail.com>
> ---
>  doxygen/.gitignore  |  1 +
>  doxygen/Makefile    |  3 ++-
>  doxygen/header.html |  1 +
>  doxygen/nir.doxy    | 50
> ++++++++++++++++++++++++++++++++++++++++++++++++++
>  4 files changed, 54 insertions(+), 1 deletion(-)
>  create mode 100644 doxygen/nir.doxy
>
> diff --git a/doxygen/.gitignore b/doxygen/.gitignore
> index a5f3921..ed94bed 100644
> --- a/doxygen/.gitignore
> +++ b/doxygen/.gitignore
> @@ -14,6 +14,7 @@ main
>  math
>  math_subset
>  miniglx
> +nir
>  radeondrm
>  radeonfb
>  radeon_subset
> diff --git a/doxygen/Makefile b/doxygen/Makefile
> index 01c2691..cbbb40e 100644
> --- a/doxygen/Makefile
> +++ b/doxygen/Makefile
> @@ -18,7 +18,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/header.html b/doxygen/header.html
> index abd736f..8e656c1 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="../shader/index.html">shader</a> |
> diff --git a/doxygen/nir.doxy b/doxygen/nir.doxy
> new file mode 100644
> index 0000000..7e431ac
> --- /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
>

With the above line replaced with 'vbo.tag=../vbo' that patch would get my:

Reviewed-by: Rhys Kidd <rhyskidd at gmail.com>

I'm about to publish a set of patches that make that correction throughout
$MESA_TOP/doxygen, however no point adding another incorrect one while
you're at it.


> +GENERATE_TAGFILE       = nir.tag
> --
> 1.9.1
>
> _______________________________________________
> mesa-dev mailing list
> mesa-dev at lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/mesa-dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.freedesktop.org/archives/mesa-dev/attachments/20160409/506159da/attachment-0001.html>