[Libreoffice-commits] core.git: Changes to 'feature/doxygen'
Michael Stahl
mstahl at redhat.com
Fri May 3 07:41:51 PDT 2013
New branch 'feature/doxygen' available with the following commits:
commit 2767d40c6c79f5c1b1643112dafcc8cfd376f773
Author: Michael Stahl <mstahl at redhat.com>
Date: Fri May 3 00:27:05 2013 +0200
offapi: fix another mangled comment
Change-Id: I76b531238d86c9f2ed444d230638ffb9a2d62618
commit 969ab4614b74a1c58c939092ce21426614104ece
Author: Michael Stahl <mstahl at redhat.com>
Date: Wed May 1 18:54:37 2013 +0200
*api: document all modules in modules.idl
Change-Id: I1c0c89f515f06bd14b659836d777aa705a6f03d6
commit a6f9317b1166efd1d2a07eac56fc35b2de0461e2
Author: Michael Stahl <mstahl at redhat.com>
Date: Wed May 1 00:31:39 2013 +0200
*api: fix more bad <pre> (tweak monster comment in Content.idl)
Change-Id: Ibedb43cf201013a7c5da6001d8a3cb4866e5ecb4
commit c185760e8a2d782ecb9c5d312572836077d7f3b1
Author: Michael Stahl <mstahl at redhat.com>
Date: Wed May 1 00:26:55 2013 +0200
*api: fix loads of badly documented parameters
Change-Id: Ifcfdcc1aee5f45745ab17d83f69c2cf293b58196
commit c55b35895501a4e54a03df5d9896f252a8c33d83
Author: Michael Stahl <mstahl at redhat.com>
Date: Tue Apr 30 22:38:04 2013 +0200
*api: doxygen complains about lonely "." being list marker
Change-Id: Icaed7afe8f2463ffc16421642ff2e073fb4b7cc1
commit ee2ada8913089d180c11ef79cd826c38c4ad6589
Author: Michael Stahl <mstahl at redhat.com>
Date: Tue Apr 30 21:44:41 2013 +0200
*api: fix bunch of lists that doxygen warns about
Change-Id: Ic507170e94d08155430601658689b3d7b96e0f80
commit 40804a5dbf346f7bb5020df057e314f919ef1db6
Author: Michael Stahl <mstahl at redhat.com>
Date: Tue Apr 30 17:02:37 2013 +0200
*api: fix a bunch of "illegal" and "empty" tags
Apparently doxygen doesn't like XML-style empty elements.
Change-Id: I0fe8105a196fa3cf5b980f0b6f18933adf8a1d53
commit dd8938bbab8244a150f3aef08afe88322ab62578
Author: Michael Stahl <mstahl at redhat.com>
Date: Tue Apr 30 16:29:23 2013 +0200
*api: fix unterminated tags
Change-Id: Iff23e173e4726682c719c5de303fded0bc671bd3
commit 92c5456eb28640bfb81127f67555b36a27cef3dd
Author: Michael Stahl <mstahl at redhat.com>
Date: Tue Apr 30 15:58:24 2013 +0200
*api: fix all unknown commands
Change-Id: Ied26925485b2be649cabafff338e6d78c7bd17b3
commit a2e29b9bdc777ca685601f6eda6f3b8603ffe4b8
Author: Michael Stahl <mstahl at redhat.com>
Date: Tue Apr 30 15:02:28 2013 +0200
*api: convert unsupported HTML entities
Most of these are just cosmetic, and middot can be replaced by cdot.
Change-Id: I39a45a2d5d0f10b5b0e793b6fa5e0c041c4669d5
commit 2bcbc763e1d2d6156f35d6ee74c6c0654cb24e84
Author: Michael Stahl <mstahl at redhat.com>
Date: Tue Apr 30 14:12:14 2013 +0200
*api: convert all unsupported html tags
Only useful ones appear to be <tbody> and <thead> which doxygen doesn't
support but we only use those in 3 places so who cares.
Change-Id: I374f7d208873a8436fe76e0f800ce18df5b188b3
commit 3dd11fb28019f0418dbac2d7a71164304436cf8f
Author: Michael Stahl <mstahl at redhat.com>
Date: Tue Apr 30 00:15:22 2013 +0200
*api: convert <listing> and @example
<listing> is called @code / @endcode in doxygen.
@example requires a file name in doxygen.
Also adapt various silly examples that use tools String in C++ or manual
syntax highlighting in Java etc.
Change-Id: I23cff1b688001f438526a6a1364cc5f754b504f7
commit 76734e0d2b494f041cf2efc134d139932f9900fc
Author: Michael Stahl <mstahl at redhat.com>
Date: Mon Apr 29 18:54:48 2013 +0200
*api: convert remaining elements with "scope" attribute
Apparently <module> is yet another imaginary thing autodoc doesn't know.
Change-Id: I25382f8c2ae024d29ae20ab3b85740e9d6a9e9da
commit 1ab6c5dfda8f9e3c1c1f9ef5c82c52864fc5959a
Author: Michael Stahl <mstahl at redhat.com>
Date: Mon Apr 29 18:33:02 2013 +0200
*api: clean up multi-line and mal-formed XML tags
It is amazing what some people believe autodoc supports.
Also, com::sun::star::uno::Any does not exist in IDL, that is part of
the C++ language binding.
Change-Id: I1f1f5cf5d27663ace6ff618ecbecb41fd2dfa1fc
commit 31a4774f92ff9ba314d7fb848198520314988f15
Author: Michael Stahl <mstahl at redhat.com>
Date: Mon Apr 29 00:19:39 2013 +0200
*api: convert more <method>
sed -i "s,<method>\([^<]\+\)</method>,\1,g"
Change-Id: Ic3eef0c03e512f7d607a87c58f9f01626f5a57a1
commit acc380b801fcd7712789e7bce9ca23a14bc5db4a
Author: Michael Stahl <mstahl at redhat.com>
Date: Mon Apr 29 00:18:07 2013 +0200
*api: convert more <method>
sed -i "s,<method>\([^<]\+[^)]\)</method>,\1(),g"
Change-Id: Ie443efb5b283067bc5475810f6848061900d8401
commit cba0c61a7c81650045e41d41896b68e509d5e28d
Author: Michael Stahl <mstahl at redhat.com>
Date: Sun Apr 28 00:44:31 2013 +0200
*api: convert <TRUE/> <FALSE/> <VOID/> <NULL/>
sed -i 's,<\(TRUE\|FALSE\|VOID\|NULL\)/>,`\1`,g'
Change-Id: Ia4df97ca809b00993530d67203bbe4ba7a072201
commit de528e5e484c811ff8689fc91dd65eb00cdb7474
Author: Michael Stahl <mstahl at redhat.com>
Date: Sun Apr 28 00:27:46 2013 +0200
*api: convert <true/> <false/> <void/>
sed -i 's,<\(true\|false\|void\)/>,`\U\1`,g'
Change-Id: I87a6e81ff22b47ea979322d01c49350892d3945f
commit ca6c14e7ba952f2ad9eb90cfddb62a561a459a50
Author: Michael Stahl <mstahl at redhat.com>
Date: Sun Apr 28 00:15:21 2013 +0200
*api: convert <atom>
sed -i 's,<atom>\([^<]\+\)</atom>,`\1`,g'
Change-Id: I530fe998b0c422e83c4324807d42700126bc9883
commit 9ae2852c2605679a809dfe57908a861ee3bdd428
Author: Michael Stahl <mstahl at redhat.com>
Date: Sun Apr 28 00:07:48 2013 +0200
*api: convert more <method scope="foo">
sed -i 's,<method scope="\([^"]*\)">\([^<]\+\)</method>,\1::\2,g'
Change-Id: I09ee9ecae922e0b28730d1689b802e6041b3ceed
commit 2f9ee22e1819ef6ba9675159b81cb4732509d700
Author: Michael Stahl <mstahl at redhat.com>
Date: Sun Apr 28 00:06:26 2013 +0200
*api: convert <method scope="foo">
sed -i 's,<method scope="\([^"]*\)">\([^<][^)]\+\)</method>,\1::\2(),g'
Change-Id: I7ceb805d67a79c297fb5f044a8fb226ec2fb366c
commit 2f687cf6f49ed2cae49d76e95259240e4202af5d
Author: Michael Stahl <mstahl at redhat.com>
Date: Sun Apr 28 00:02:01 2013 +0200
*api: convert <method>
sed -i "s,<method>\([a-z][^<]\+\)</method>,\1,g"
Change-Id: I9483d63cce4afd168d47a465b367aed3da45d64b
commit 7e8fcbf3d38f3f130a6796efd73691dee00ee529
Author: Michael Stahl <mstahl at redhat.com>
Date: Sun Apr 28 00:00:27 2013 +0200
*api: convert <method>foo()</method>
What is sad about this is that autodoc doesn't even support <method>.
sed -i "s,<method>\([a-z][^<]\+[^)]\)</method>,\1(),g"
Change-Id: I702ef71423ced1d5195f2e0535e73b1bb4d3f6f2
commit 635761e57b8f1f9954a7092914af227b5d2a9da4
Author: Michael Stahl <mstahl at redhat.com>
Date: Sat Apr 27 23:52:30 2013 +0200
*api: convert <arg>
... which does not seem to do anything anyway.
sed -i "s,<arg>\([^<]\+\)</arg>,\1,g"
Change-Id: I90bcf81ea046bc88297ed8eadc560ad31d19830b
commit 8fc9d9f17f9d5f7f02b927cf550ed62ec998c224
Author: Michael Stahl <mstahl at redhat.com>
Date: Sat Apr 27 23:45:24 2013 +0200
*api: convert <const>
This one is apparently often abused to link to a constant group, while
it can only link to constants within a group.
sed -i "s,<const>\([^<]\+\)</const>,\1,g"
Change-Id: Ic3d8099751340e4b046298c861bb659beb351eaf
commit cc2cfe273af580c28fca7679b4bfcb45bc146e89
Author: Michael Stahl <mstahl at redhat.com>
Date: Sat Apr 27 23:40:53 2013 +0200
*api: convert <const scope="foo">
sed -i 's,<const scope="\([^"]*\)">\([^<]\+\)</const>,\1::\2,g'
Change-Id: I964acc2725e8a6680f5bd8412014e5660510749e
commit c3fee56a190321a6f5bf11fc8de9efa6d6bd75b0
Author: Michael Stahl <mstahl at redhat.com>
Date: Sat Apr 27 23:25:41 2013 +0200
*api: convert rest of <member scope="foo">
sed -i 's,<member scope="\([^"]*\)">\([^<]\+\)</member>,\1::\2,g'
Change-Id: Idbe0adc5a88e430c99257d4d61e540bf0eeaea8f
commit bb93192cd1c11ee7fd6ead68c93f23e2aa478de4
Author: Michael Stahl <mstahl at redhat.com>
Date: Sat Apr 27 23:21:10 2013 +0200
*api: convert remaining <member>
sed -i "s,<member>\([^<]\+\)</member>,\1,g"
Change-Id: I74c80f5aa610477fab28faec52e55c3137984aec
commit a8ed5cc55f03ec72a6fcb6f229bb2219209c6beb
Author: Michael Stahl <mstahl at redhat.com>
Date: Sat Apr 27 23:14:19 2013 +0200
*api: replace <member>Foo</member>
These member variables need a # prefix.
sed -i "s,<member>\([^<:]\+[^)]\)</member>,#\1,g"
Change-Id: I721b90f4edae32b5a362479bdbd60423f6427364
commit 808804bce40a2d8815e1fc3a8aaaaa486729768a
Author: Michael Stahl <mstahl at redhat.com>
Date: Sat Apr 27 22:45:02 2013 +0200
*api: convert <member scope="foo">bar</member>
sed -i 's,<member scope="\([^"]*\)">\([^<]*::[a-z][^<:]\+[^)]\)</member>,\1::\2(),g'
Change-Id: I265ff28fee73a271f205294e59955b3a1c81d95a
commit 5200e2ec27ba314429c486020398c13871683084
Author: Michael Stahl <mstahl at redhat.com>
Date: Sat Apr 27 22:32:23 2013 +0200
*api: convert <member>Foo::bar</member>
Doxygen would probably recognize these without () too but add them for
consistency.
sed -i "s,<member>\([^<]*::[a-z][^<:]\+[^)]\)</member>,\1(),g"
Change-Id: I2615b99265b75633459e35164e54d9da7fe76b85
commit f174e30eba4f5a0190caa71e4eefa1f29e135de3
Author: Michael Stahl <mstahl at redhat.com>
Date: Sat Apr 27 22:20:42 2013 +0200
*api: convert <member>method</member> to method()
Doxygen will only recognize a un-qualified method name as such if it is
followed by "()".
sed -i "s,<member>\([a-z][^<]\+[^)]\)</member>,\1(),g"
Change-Id: I69bc17849e76f3a3d91c6daf0f1be8168a83cfc5
commit 2e3965e8d8bf822625b1a7fe714918d9269f8286
Author: Michael Stahl <mstahl at redhat.com>
Date: Sat Apr 27 21:58:51 2013 +0200
*api: convert <type scope="bar">Foo</type>
This looks much better now.
sed -i 's,<type scope="\([^"]*\)">\([^<]\+\)</type>,\1::\2,g'
Change-Id: I94cd0f93afa89855b62dadeb229d2b2e1775cd80
commit 24a4245d9576a333464d359d1c95e61aaa54ae3a
Author: Michael Stahl <mstahl at redhat.com>
Date: Sat Apr 27 21:47:17 2013 +0200
*api: convert <type>Foo</type>
Doxygen does not know type element and will recognize strings that
contain capital letter (all API types do) automatically as type.
This patch removes 15k doxygen warnings.
git ls-files | grep \\.idl | xargs sed -i "s,<type>\([^<]\+\)</type>,\1,"
Change-Id: I45c07cf0b115d5fb5353f4aa9719839615ea1150
commit 91d28cfa941980a5fef1cd05714b6e550685a140
Author: Michael Stahl <mstahl at redhat.com>
Date: Mon Apr 29 19:07:59 2013 +0200
include: convert <type> here too
sed -i "s,<type>\([^<]\+\)</type>,\1,"
Change-Id: Ibdaeb2c396ad29ced05716142b38c6a1c3e49847
commit d6e3a023c043cd4df5f3815a397c27a957acbdf9
Author: Michael Stahl <mstahl at redhat.com>
Date: Mon Apr 29 19:06:50 2013 +0200
include: convert type scope="foo"> here too
sed -i 's,<type scope="\([^"]*\)">\([^<]\+\)</type>,\1::\2,g'
Change-Id: I7eb32acd44132de79cc7ac1e7f78b43bb4814d14
commit b3dbf93c5e18b6f31b11f9bcc08a105b2e0d3b10
Author: Michael Stahl <mstahl at redhat.com>
Date: Fri May 3 16:11:42 2013 +0200
odk: add DevGuide wiki links to doxygen documentation
Unsurprisingly doxygen does not support reading a idl_chapter_refs.txt
file like autodoc does. And it looks like doxygen tag files can not
be used to do this, as they link only in the "other" direction.
But with a bit of hackery we can generate a "dummy" IDL input file, with
emtpy definitions for those types that have DevGuide links.
Doxygen will nicely combine documentation from multiple definitions of a
type, and fortunately does only put in references to the first file that
defines a type, so hopefully adding the generated file as the last input
file is suffficient to make things work nicely.
The generated file is committed to git because there is a bit of a
problem with finding out what sort of entity a name like
"com.sun.star.Foo" refers to, which needs to be in the doxygen input.
Change-Id: I793bc59c8acfecf460e4addea7838c76a3ede77e
commit 4dd252f64447a87294efeac4cce454960125cf66
Author: Michael Stahl <mstahl at redhat.com>
Date: Fri May 3 15:24:49 2013 +0200
odk: remove output directory before invoking doxygen
Change-Id: I04b8dbecbe62f8d72ca75f6508046294c3409a17
commit 570dc94fc6279ccd87e0e83ed1461237bd5506dc
Author: Michael Stahl <mstahl at redhat.com>
Date: Sat Apr 27 20:15:24 2013 +0200
odk: generate IDL docs with doxygen
Change-Id: Ibf7ab46bdd08a42ecf475500d35f92b67d4d8036
commit e29dca47bdcf26a88f3b41b2768fd63b6a8cdc13
Author: Michael Stahl <mstahl at redhat.com>
Date: Fri Apr 26 18:40:56 2013 +0200
odk: generalize CustomTarget_doxygen a bit
Change-Id: Ic3f2d42121b5423d67c4c79302b02ac495ac9640
commit ea8dae5f776a9e6cb6647b3b0aec81420ced3818
Author: Michael Stahl <mstahl at redhat.com>
Date: Fri Apr 26 17:39:45 2013 +0200
odk: clean up CustomTarget_doxygen.mk
- give right path to STRIP_FROM_PATH
- prefix vars
- depend on makefile
- only call cygpath in rule
Change-Id: Iceef191751b82a423be354db1f0a3ca4fc213e04
More information about the Libreoffice-commits
mailing list