[Intel-gfx] [PATCH 1/1] Documentation: drm: describing drm properties exposed by various drivers

[Daniel Vetter]

On Tue, May 13, 2014 at 1:02 PM, Laurent Pinchart
<laurent.pinchart at ideasonboard.com> wrote:
>> Also eventually I want to pull these tables directly out of source
>> code comments - everything else tends to never get updated when the
>> code changes.
>
> On the subject of moving documentation from docbook to source code, do your
> kerneldoc extensions plans include supporting images ? A drawing is worth a
> thousand words (see http://linuxtv.org/downloads/v4l-dvb-apis/subdev.html#subdev-image-processing-scaling-multi-source for instance),
> and that's currently a pretty important feature of the docbook format.

That looks great I think I'll get a bit of doc envy ;-)

I don't think there's any reasonable way to generate such figures from
comments, maybe for simple ones some ascii art might work out. But
converting that to svg for the docbook seems to be an unsovled problem
(I've only found some hacks), so I think we need to manually pull
those into the docbook still. But excellent point for consideration.
-Daniel
-- 
Daniel Vetter
Software Engineer, Intel Corporation
+41 (0) 79 365 57 48 - http://blog.ffwll.ch