docs: document some annotationparser.py hacking hints
giscanner: deprecate top level g-i specific GTK-Doc tags.

Rationale
---------

The first wave of improvements on AnnotationParser intended
to fix bug http://bugzilla.gnome.org/show_bug.cgi?id=672254
(multiline descriptions on tags not working correctly, polluting
the comment block description instead) had an unforeseen side
effect reported in bug http://bugzilla.gnome.org/show_bug.cgi?id=674658.

Analyzing this problem we found that even though comment blocks
having g-i specific tags before the comment block description
are technically malformed, the old annotationparser code happily
accepted these without complaint. During this analysis, a secondary
bug report (http://bugzilla.gnome.org/show_bug.cgi?id=676133)
was filed with the GTK-Doc project because it was found that the
same malformed tags did not result in the expected html output.

After discussing this with the GTK-Doc maintainers, we learned
that our g-i specific top level tags should never have existed
in the first place. The prefered notation for annotations that
apply to the identifier should be written on the identifier line,
for example like what we already do with (skip).

As a result, this patch deprecates g-i specific top level tags and
implements them as annotations on the identifier instead and at
the same time adds support for malformed comment blocks still
using g-i specific top level tags.

This means that all annotated code "out there" will continue to work
just fine with this version of g-i, but when a developer decides to
fix deprecation warnings in his/her comment blocks, the dependency
on g-i needs to be raised to a version that contains at least this
patch.

Overview of changes
-------------------

1) giscanner/annotationparser.py and giscanner/maintransformer.py
   have been adjusted to deprecate g-i specific top level tags
   and now implement these in terms of annotations on the identifier.
   The Attributes: tag and it's replacement (attributes) annotation
   continue to be broken (regression introduced in commit
   182fdfec261f36fa095484352b9b834861036907), which will be
   addressed in a followup patch.

2) AnnotationParser().parse_options() has learned to correctly parse
   multiple closing parentheses, which is for example required for the
   new syntax in tests/scanner/annotationparser/gi/annotation_type.xml:
   * AnnotationObject:hash-table: (type GLib.HashTable(utf8,gint8))

3) comment blocks in tests/*.c and tests/*.h had to be adjusted as
   these tests are not allowed to emit warnings. As a result, these
   test cases now no longer use g-i specific top level tags but
   annotations on the identifier instead.

https://bugzilla.gnome.org/show_bug.cgi?id=688897
https://bugzilla.gnome.org/show_bug.cgi?id=676133
https://bugzilla.gnome.org/show_bug.cgi?id=674658
giscanner: move AnnotationParser() warning tests

The following patch (add support for deprecated @Varargs
parameter notation) would require adding a new expected
warning to tests/warn/unknown-parameter.h before all
other warnings, even those from unrelated comment blocks.
This because AnnotationParser() warnings are emitted *before*
MainTransformer() warnings.

This patch extracts all warning tests related to AnnotationParser()
into the test_parser.py testsuite instead.
giscanner: add support for deprecated @Varargs parameter notation

Transparently transform @Varargs into @... and add tests.
giscanner: fix Attributes: tag transformation into (attributes) annotation
giscanner: deprecate (attribute) annotation...

...and replace it with (attributes). This allows
for multiple key/value pairs to be annotated with
the (attributes key1=value2 key2 key3=value2) notation
instead of a single (attribute key value)...
giscanner: fix string formatting tuples

During review Colin Walters mentioned:

"""
One thing I should probably explain is my habit of *always* passing a
tuple for %.  The reason is pretty simple...a long time ago I had an
error handler that did:  print "unexpected data: %s" % foo.  And I'd
changed the type of "foo" from a string to a tuple at some point.
But this obviously caused "print" to fail because it was expecting
multiple format strings.

Basically always using tuples is safer in case you change the type
of a variable to a tuple.
"""

This fixes the violations of this rule not introduced in this
set of patches.
giscanner: remove dead code
giscanner: handle deprecated angled brackets in deprecated "Type:", "(type)" and (element-type)
giscanner: always store DocTag.comment, drop DocTag.value usage
giscanner: fix erronous "missing ':'" warnings
giscanner: improve wording of inline documentation
giscanner: remove unused variables
giscanner: prefer "except X as e" over "except X, e"

It's more readable and as an added bonus Python 3 compatible.
giscanner: refactoring: rename colon to delimiter
giscanner: refactoring: rename options to annotations

and stop confusing them with array, out, scope and transfer options
which where confusingly also names options...
giscanner: refactoring: rename comment to description

Besause that's what they are called.
giscanner: refactoring: rename DocBlock to GtkDocBlock

Because GTK-Doc comment blocks are the only kind of
comment blocks we're interested in.
giscanner: refactoring: clarify PART_* and SUBJECT_* constants

The PART_* and SUBJECT_* constants are only ever used to
track state in _parse_comment_block(). This is unlike the
TAG_*, ANN_* and OPT_* constants which are used to match
the input GTK-Doc comment block text.

Changing these to simple ints makes the difference clear.
giscanner: refactoring: order TAG_* constants alphabetically

Makes it easier to locate things