Re: Kernel API Reference Documentation

[Lukas Jelinek]

> hoi :)
> 
> when I once experimented with doxygen, I used the following script to
> convert some kerneldoc comments to doxygen syntax:
> 
> #!/usr/bin/perl -wpi
> 
> use strict;
> 
> BEGIN { $::state = 0; }
> 
> if ($::state == 0) {
> 	$::state = 1 if /\/\*\*/;
> } elsif ($::state == 1) {
> 	s/(\*\s+)(struct\s+|enum\s+)?\S+ - /$1/;
> 	s/$/\./ unless /\.$/;
> 	$::state = 2;
> } elsif ($::state == 2) {
> 	s/(\*\s+)\@(\w+):\s+(.*)/$1\\param $2 $3./;
> 	s/(\s+)[%&\@](\S+)/$1$2/g;
> }
> s/\.\.$/./;
> 
> $::state = 0 if /\*\//;
> 

A good idea! Thanks. I will try it and compare to the result of my sed
script.

Lukas

-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/