[Development] Request: Mark classes with \module in documentation

Thiago Macieira thiago.macieira at intel.com
Thu Aug 23 12:29:06 CEST 2012


On quinta-feira, 23 de agosto de 2012 12.10.35, Thiago Macieira wrote:
> On quinta-feira, 23 de agosto de 2012 07.30.23, casper.vandonderen at nokia.com
> wrote:
> > What needs to be done:
> > - Find the qdoc comment containing \class in your classes.
> > - Add a new line containing the text "\inmodule [modulename]"
> > - Do this for each of the classes, that does not have an \inmodule command
> > yet.
> 
> I'm doing it for QtCore and QtDBus now.

Script:
git grep -lF \\class | xargs perl -pi -e 'if (/^(.*)\\class/) { $spaces = $1; 
print $_; $spaces =~ s/./ /g; $_ = "$spaces\\inmodule QtDBus\n"; }'

Then verify if you're not duplicating anything. I compared to the existing 
\inmodule listing, obtained from:

	git grep -nF \\inmodule HEAD

-- 
Thiago Macieira - thiago.macieira (AT) intel.com
  Software Architect - Intel Open Source Technology Center
     Intel Sweden AB - Registration Number: 556189-6027
     Knarrarnäsgatan 15, 164 40 Kista, Stockholm, Sweden
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 190 bytes
Desc: This is a digitally signed message part.
URL: <http://lists.qt-project.org/pipermail/development/attachments/20120823/b1bac26f/attachment.sig>


More information about the Development mailing list