flex-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Rick Winscot <rick.wins...@gmail.com>
Subject Re: Proposition :: ASDoc and compiler adjustments
Date Wed, 04 Jan 2012 23:01:54 GMT

This sounds like an interesting idea. I've been all over MetaAS, PMD, and Code Model... which
is what it would take to make something like this happen. Why so much depth? Mainly, because
'docs' aren't just 'text.' A good example would be web-links between classes, references,
etc. Code formatting, doc generation, and compiler hooks could get pretty involved (I love
a challenge).

You've piqued my interest... what kind of specific use cases are you thinking about?


Rick Winscot

On Wednesday, January 4, 2012 at 5:40 PM, Michael Schmalle wrote:

> Hi,
> I do not have a lot of experience with the actual compiler and asdoc 
> tool but that has not stopped me from having fun with parsers and AST. 
> :)
> I am wondering if there is any interest in creating some apis in the 
> compiler that jive with the asdoc tool(modifying the asdoc tool). I'm 
> going to be looking into the source code of this tomorrow so I will 
> have a clear understanding of what the work would be.
> My idea is this; If we could allow public api in both tools that 
> expose themselves through java it would allow 3rd party developers and 
> applications that could be made to enhance the documentation process 
> through formatters and asdoc editor applications.
> This a highlevel idea but I have already written such an application 
> using the jasblocks and asblocks AST framework, that are used to 
> create a user interface into creating asdoc comments and such through 
> visual editing of descriptions and tags.
> No more typing /** ... */ is what I mean, the editor using the AST 
> reinserts the comment using tokens.
> I have found taking the actual documentation process out of the IDE's 
> code view allows for better documentation and actual revelation that 
> creating great docs can be fun.
> Any interest?
> Mike 

  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message