public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Lukas Jelinek <info@kernel-api.org>
To: Martin Waitz <tali@admingilde.org>
Cc: Steven Rostedt <rostedt@goodmis.org>,
	"Randy.Dunlap" <rdunlap@xenotime.net>,
	linux-kernel@vger.kernel.org
Subject: Re: Kernel API Reference Documentation
Date: Wed, 28 Jun 2006 14:26:17 +0200	[thread overview]
Message-ID: <44A27569.1020005@kernel-api.org> (raw)
In-Reply-To: <20060628120536.GF19868@admingilde.org>

> 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


  reply	other threads:[~2006-06-28 12:26 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2006-06-27 19:22 Kernel API Reference Documentation Lukas Jelinek
2006-06-27 20:22 ` Randy.Dunlap
2006-06-27 20:42   ` Lukas Jelinek
2006-06-27 21:38     ` Randy.Dunlap
2006-06-28  9:44     ` Steven Rostedt
2006-06-28 10:01       ` Andreas Schwab
2006-06-28 12:05       ` Martin Waitz
2006-06-28 12:26         ` Lukas Jelinek [this message]
2006-06-28 11:47 ` Petr Tesarik
2006-06-28 12:22   ` Lukas Jelinek
2006-06-28 16:09     ` Randy.Dunlap
2006-06-28 16:13       ` Petr Tesarik
2006-06-28 16:36         ` Randy.Dunlap
2006-06-28 16:41           ` Lukas Jelinek
2006-06-28 16:50             ` Randy.Dunlap
2006-06-28 17:49               ` Lukas Jelinek

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=44A27569.1020005@kernel-api.org \
    --to=info@kernel-api.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rdunlap@xenotime.net \
    --cc=rostedt@goodmis.org \
    --cc=tali@admingilde.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox