[Mesa-dev] [PATCH] vulkan: Initial partial documentation for Vulkan internals.

[Rhys Kidd]

On 14 October 2016 at 10:36, <kevin.rogovin at intel.com> wrote:

> From: Kevin Rogovin <kevin.rogovin at intel.com>
>
> A main page ala Doxygen together with a Doxygen file added.
> In addition, documentation for portions of anv_private.h:
>  - placing portions into doxygen groups
>  - some cross linking doxygen style to other files
>

Hello Kevin,

Thanks for the initial steps to document anv.

Can I make two suggestions:
1. Split out into two patches: (a) adding of inline comments to .c/.h
files; and (b) the doxygen plumbing.
2. In relation to the doxygen plumbing you can leverage the existing
($top_dir)/doxygen/ to reduce your patch size.

Suggest that you look at how i965.doxy and common.doxy interact.


>
> Signed-off-by: Kevin Rogovin <kevin.rogovin at intel.com>
> ---
>  src/intel/genxml/gen_macros.h           |    4 +-
>  src/intel/vulkan/anv_allocator.c        |    5 +-
>  src/intel/vulkan/anv_private.h          |  287 +++-
>  src/intel/vulkan/docs/.gitignore        |    1 +
>  src/intel/vulkan/docs/Doxyfile          | 2483
> +++++++++++++++++++++++++++++++
>  src/intel/vulkan/docs/intel_vulkan.doxy |   86 ++
>  6 files changed, 2845 insertions(+), 21 deletions(-)
>  create mode 100644 src/intel/vulkan/docs/.gitignore
>  create mode 100644 src/intel/vulkan/docs/Doxyfile
>  create mode 100644 src/intel/vulkan/docs/intel_vulkan.doxy
>

<snip>


>
> _______________________________________________
> 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/20161014/903a75b7/attachment-0001.html>