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

[Frank Henigman]

On Fri, Oct 4, 2013 at 1:46 PM, Chad Versace
<chad.versace at linux.intel.com> wrote:
> Now, one can do the following to generate and read the i965 Doxygen:
>
>   cd $MESA_TOP/doxygen
>   make
>   firefox i965/index.html
>
> CC: Frank Henigman <fjhenigman at google.com>
> Signed-off-by: Chad Versace <chad.versace at linux.intel.com>
> ---
>  doxygen/.gitignore |  1 +
>  doxygen/Makefile   |  3 ++-
>  doxygen/i965.doxy  | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
>  3 files changed, 53 insertions(+), 1 deletion(-)
>  create mode 100644 doxygen/i965.doxy
>
> diff --git a/doxygen/.gitignore b/doxygen/.gitignore
> index 02d0730..abf56ac 100644
> --- a/doxygen/.gitignore
> +++ b/doxygen/.gitignore
> @@ -8,6 +8,7 @@ gallium
>  gbm
>  glapi
>  glsl
> +i965
>  main
>  math
>  math_subset
> diff --git a/doxygen/Makefile b/doxygen/Makefile
> index 2bea0b3..0a95a35 100644
> --- a/doxygen/Makefile
> +++ b/doxygen/Makefile
> @@ -17,7 +17,8 @@ FULL = \
>         swrast_setup.doxy \
>         tnl.doxy \
>         tnl_dd.doxy \
> -       gbm.doxy
> +       gbm.doxy \
> +       i965.doxy
>
>  full: $(FULL:.doxy=.tag)
>         $(foreach FILE,$(FULL),doxygen $(FILE);)
> diff --git a/doxygen/i965.doxy b/doxygen/i965.doxy
> new file mode 100644
> index 0000000..1df60df
> --- /dev/null
> +++ b/doxygen/i965.doxy
> @@ -0,0 +1,50 @@
> +# Doxyfile 0.1
> +
> + at INCLUDE               = common.doxy
> +
> +#---------------------------------------------------------------------------
> +# General configuration options
> +#---------------------------------------------------------------------------
> +PROJECT_NAME           = "Intel i965 Driver"
> +#---------------------------------------------------------------------------
> +# configuration options related to the input files
> +#---------------------------------------------------------------------------
> +INPUT                  = ../src/mesa/drivers/dri/i965
> +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            = i965
> +#---------------------------------------------------------------------------
> +# 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::addtions related to external references

There's a typo "addtions" if you care.  (All the .doxy files have it.)
Also please change firefox to chrome - just kidding.  (^:

Reviewed-by: Frank Henigman <fjhenigman at google.com>

> +#---------------------------------------------------------------------------
> +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       = i965.tag
> --
> 1.8.3.1