[as2api-dev] Metatags and a couple of suggestions

[Gaspy]

------=_Part_1568_22723572.1121437559796
Content-Type: text/plain; charset=ISO-8859-1
Content-Transfer-Encoding: quoted-printable
Content-Disposition: inline

>=20
>=20
> Ah, I see. The current parser only allows these attributes to appear
> immediately preceeding the type definition.
>=20
> I guess they need to be allowed before the import statements too, but do
> you know if they should be allowed to appear interspersed within the
> import list? I suspect that they should be allowed there.
>=20
>=20
Dave, yes, I moved the import list above the metatags and it works now.

I think the parser shoud work regardless of the position of the metatags...

I also noted a few things I want to comment on:

1. If a class declares a method to be public and then a descendant class=20
overrides that method and makes it private, as2doc will still create the=20
documentation for the private method, copying it from the super class. Now,=
=20
I realize this may not be the best practice, but sometimes it's needed.

2. It may be useful sometimes to copy definitions for inherited=20
methods/properties rather than linking to them. This could be achieved via =
a=20
command line switch. If class D inherits from C, which inherits from B,=20
which inherits from A, I'd prefer to have the methods for class D in one=20
page so I can print it, rather than having to check three other classes. To=
=20
use the MX2004 components as an example, we have UIObject --> UIComponent=
=20
--> SimpleButton --> Button. The documentation for Button should contain=20
everything, as very few people will dig...

What do you think?

Armand

------=_Part_1568_22723572.1121437559796
Content-Type: text/html; charset=ISO-8859-1
Content-Transfer-Encoding: quoted-printable
Content-Disposition: inline

<div><blockquote class=3D"gmail_quote" style=3D"border-left: 1px solid rgb(=
204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;"><br>Ah, I se=
e.&nbsp;&nbsp;The current parser only allows these attributes to appear<br>=
immediately preceeding the type definition.
<br><br>I guess they need to be allowed before the import statements too, b=
ut do<br>you know if they should be allowed to appear interspersed within t=
he<br>import list?&nbsp;&nbsp;I suspect that they should be allowed there.<=
br><br>
</blockquote></div><br>
Dave, yes, I moved the import list above the metatags and it works now.<br>
<br>
I think the parser shoud work regardless of the position of the metatags...=
<br>
<br>
I also noted a few things I want to comment on:<br>
<br>
1. If a class declares a method to be public and then a descendant
class overrides that method and makes it private, as2doc will still
create the documentation for the private method, copying it from the
super class. Now, I realize this may not be the best practice, but
sometimes it's needed.<br>
<br>
2. It may be useful sometimes to copy definitions for inherited
methods/properties rather than linking to them. This could be achieved
via a command line switch. If class D inherits from C, which inherits
from B, which inherits from A, I'd prefer to have the methods for class
D in one page so I can print it, rather than having to check three
other classes. To use the MX2004 components as an example, we have
UIObject --&gt; UIComponent --&gt; SimpleButton --&gt; Button. The
documentation for Button should contain everything, as very few people
will dig...<br>
<br>
What do you think?<br>
<br>
Armand<br>

------=_Part_1568_22723572.1121437559796--