Re: [PATCH] scripts/kernel-doc: support for structs, unions, enum, typedef and other stuff

J . A . Magallon (jamagallon@able.es)
Wed, 26 Sep 2001 16:02:23 +0200


On 20010926 Tim Jansen wrote:
>Hi...
>
>The attached patch for scripts/kernel-doc adds the following features:
>
>1. You can document structs, unions, enums and typedef like this:
>/**
> * enum driver_type - Describes the type of a driver
> * @DRIVER_TYPE_DEVICE: driver controls a device (like fd.o)
> * @DRIVER_TYPE_BUS: driver manages a bus (like usbcore.o)
> *
> * Some description.
> */
>enum driver_type {
> DRIVER_TYPE_DEVICE = 0,
> DRIVER_TYPE_BUS = 1,
>};
>

I suppose it is too late, but can be an idea for 2.5.

Why do not use doxygen, instead of rewriting it ?

Yes, it adds another package dependency for kernel sources, but only for
people that wants to rebuild docs instead of using shipped ones.

-- 
J.A. Magallon                           #  Let the source be with you...        
mailto:jamagallon@able.es
Mandrake Linux release 8.1 (Cooker) for i586
Linux werewolf 2.4.10-beo #1 SMP Tue Sep 25 23:38:05 CEST 2001 i686
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/