All of lore.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
To: Linux Media Mailing List <linux-media@vger.kernel.org>
Cc: "Mauro Carvalho Chehab" <mchehab@osg.samsung.com>,
	"Jonathan Corbet" <corbet@lwn.net>,
	"Andrew Morton" <akpm@linux-foundation.org>,
	"Ben Hutchings" <ben@decadent.org.uk>,
	"Johannes Berg" <johannes.berg@intel.com>,
	"Jérémy Bobbio" <lunar@debian.org>,
	"Danilo Cesar Lemes de Paula" <danilo.cesar@collabora.co.uk>,
	"Bart Van Assche" <bart.vanassche@sandisk.com>
Subject: [PATCH 19/26] kernel-doc: Add a parser for function typedefs
Date: Sat, 10 Oct 2015 10:36:02 -0300	[thread overview]
Message-ID: <3a80a766328fe73df5951639b5c9013ddba6efec.1444483819.git.mchehab@osg.samsung.com> (raw)
In-Reply-To: <cover.1444483819.git.mchehab@osg.samsung.com>
In-Reply-To: <cover.1444483819.git.mchehab@osg.samsung.com>

The current typedef parser only works for non-function typedefs.

As we need to also document some function typedefs, add a
parser for it.

Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>

diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index 9a08fb5c1af6..55ce47ffa02d 100755
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -1886,6 +1886,18 @@ sub dump_typedef($$) {
 			    'purpose' => $declaration_purpose
 			   });
     }
+    elsif ($x =~ /typedef\s+\w+\s*\(\*\s*(\w\S+)\s*\)\s*\(/) { # functions
+	$declaration_name = $1;
+
+	output_declaration($declaration_name,
+			   'typedef',
+			   {'typedef' => $declaration_name,
+			    'module' => $modulename,
+			    'sectionlist' => \@sectionlist,
+			    'sections' => \%sections,
+			    'purpose' => $declaration_purpose
+			   });
+    }
     else {
 	print STDERR "${file}:$.: error: Cannot parse typedef!\n";
 	++$errors;
-- 
2.4.3



  parent reply	other threads:[~2015-10-10 13:36 UTC|newest]

Thread overview: 27+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-10-10 13:35 [PATCH 00/26] Some improvements for the media API Mauro Carvalho Chehab
2015-10-10 13:35 ` [PATCH 01/26] [media] DocBook: Document include/media/tuner.h Mauro Carvalho Chehab
2015-10-10 13:35 ` [PATCH 02/26] [media] tuner.h: Make checkpatch.pl happier Mauro Carvalho Chehab
2015-10-10 13:35 ` [PATCH 03/26] [media] DocBook: convert struct tuner_parms to doc-nano format Mauro Carvalho Chehab
2015-10-10 13:35 ` [PATCH 04/26] [media] DocBook: add documentation for tuner-types.h Mauro Carvalho Chehab
2015-10-10 13:35 ` [PATCH 05/26] [media] tveeprom: Remove two unused fields from struct Mauro Carvalho Chehab
2015-10-10 13:35 ` [PATCH 06/26] [media] DocBook: Document tveeprom.h Mauro Carvalho Chehab
2015-10-10 13:35 ` [PATCH 07/26] [media] DocBook: Convert struct lirc_driver to doc-nano format Mauro Carvalho Chehab
2015-10-10 13:35 ` [PATCH 08/26] [media] lirc_dev.h: Make checkpatch happy Mauro Carvalho Chehab
2015-10-10 13:35 ` [PATCH 09/26] [media] DocBook: document struct dvb_ca_en50221 Mauro Carvalho Chehab
2015-10-10 13:35 ` [PATCH 10/26] [media] dvb_ca_en50221.h: Make checkpatch.pl happy Mauro Carvalho Chehab
2015-10-10 13:35 ` [PATCH 11/26] [media] DocBook: Move struct dmx_demux kABI doc to demux.h Mauro Carvalho Chehab
2015-10-10 13:35 ` [PATCH 12/26] [media] DocBook: update documented fields at struct dmx_demux Mauro Carvalho Chehab
2015-10-10 13:35 ` [PATCH 13/26] [media] dvb: don't keep support for undocumented features Mauro Carvalho Chehab
2015-10-10 13:35 ` [PATCH 14/26] [media] DocBook: finish documenting struct dmx_demux Mauro Carvalho Chehab
2015-10-10 13:35 ` [PATCH 15/26] [media] dvb: get rid of enum dmx_success Mauro Carvalho Chehab
2015-10-10 13:35 ` [PATCH 16/26] [media] dvb: Remove unused frontend sources at demux.h and sync doc Mauro Carvalho Chehab
2015-10-10 13:36 ` [PATCH 17/26] [media] DocBook: document the other structs/enums of demux.h Mauro Carvalho Chehab
2015-10-10 13:36 ` [PATCH 18/26] [media] demux.h: make checkpatch.ph happy Mauro Carvalho Chehab
2015-10-10 13:36 ` Mauro Carvalho Chehab [this message]
2015-10-10 13:36 ` [PATCH 20/26] kernel-doc: better format typedef function output Mauro Carvalho Chehab
2015-10-10 13:36 ` [PATCH 21/26] [media] DocBook: document typedef dmx_ts_cb at demux.h Mauro Carvalho Chehab
2015-10-10 13:36 ` [PATCH 22/26] [media] DocBook: document typedef dmx_section_cb " Mauro Carvalho Chehab
2015-10-10 13:36 ` [PATCH 23/26] [media] demux.h: Convert TS filter type into enum Mauro Carvalho Chehab
2015-10-10 13:36 ` [PATCH 24/26] [media] demux.h: Convert MPEG-TS demux caps to an enum Mauro Carvalho Chehab
2015-10-10 13:36 ` [PATCH 25/26] [media] DocBook: Add documentation about the demux API Mauro Carvalho Chehab
2015-10-10 13:36 ` [PATCH 26/26] [media] DocBook: Remove kdapi.xml Mauro Carvalho Chehab

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=3a80a766328fe73df5951639b5c9013ddba6efec.1444483819.git.mchehab@osg.samsung.com \
    --to=mchehab@osg.samsung.com \
    --cc=akpm@linux-foundation.org \
    --cc=bart.vanassche@sandisk.com \
    --cc=ben@decadent.org.uk \
    --cc=corbet@lwn.net \
    --cc=danilo.cesar@collabora.co.uk \
    --cc=johannes.berg@intel.com \
    --cc=linux-media@vger.kernel.org \
    --cc=lunar@debian.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.