Eclipse Community Forums: Epsilon » EolDoc - Using annotations to generate documentation

Search

Help

Login

Home » Modeling » Epsilon » EolDoc - Using annotations to generate documentation(Base infrastructure for EOL documentation)

Show: Today's Messages :: Show Polls :: Message Navigator

Switch to threaded view of this topic

Create a new topic

Submit Reply

EolDoc - Using annotations to generate documentation [message #1851335]

Sun, 03 April 2022 11:19

Jörn Guy Süß is currently offline

Jörn Guy Süß

Friend

Messages: 320
Registered: July 2009
Location: Anstead, Brisbane, Queens...

Senior Member

API documentation is really important. I know the ugly that happens when a file is just a blob of script from Groovy.

EOL has the annotation feature, which could be used very well to add APIDoc requirements and add documentation.

My question is: What is the best infrastructure to get at the parse tree or a walker for EOL? Where would one start for something like this?

Report message to a moderator

Re: EolDoc - Using annotations to generate documentation [message #1851336 is a reply to message #1851335]

Sun, 03 April 2022 11:24

Jörn Guy Süß is currently offline

Jörn Guy Süß

Friend

Messages: 320
Registered: July 2009
Location: Anstead, Brisbane, Queens...

Senior Member

Another approach would be to get the comments and parse documentation from the text.
Seems lacking well-defined semantic, though
https://archive.eclipse.org/epsilon/2.2/javadoc/org/eclipse/epsilon/common/module/ModuleElement.html#getComments()

Report message to a moderator

Re: EolDoc - Using annotations to generate documentation [message #1851338 is a reply to message #1851336]

Sun, 03 April 2022 11:53

Dimitris Kolovos is currently offline

Dimitris Kolovos

Friend

Messages: 2162
Registered: July 2009
Location: York, UK

Senior Member

Hi Jörn,

Does this help? https://www.eclipse.org/epsilon/doc/articles/run-epsilon-from-java/#analysing-epsilon-programs

Best,
Dimitris

Report message to a moderator

Switch to threaded view of this topic

Create a new topic

Submit Reply

Previous Topic:	Error of assignment when generating simulink model
Next Topic:	org.eclipse.epsilon.examples.egl.flowchart is missing metamodel

Goto Forum:

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

]

Current Time: Fri Apr 19 06:34:14 GMT 2024

Powered by FUDForum. Page generated in 0.02467 seconds

.:: Contact :: Home ::.

Powered by: FUDforum 3.0.2.
Copyright ©2001-2010 FUDforum Bulletin Board Software

Back to the top