2

I find plenty of @doc annotations through the Rascal Modules, but don't know how they work. I tried to create javadoc but that's not directly supported. I feel that there must be a way to generate a collection of docs by running a process through the modules in a Rascal project. Any help is appreciated...

apil.tamang
  • 2,545
  • 7
  • 29
  • 40

2 Answers2

1

Good question which does not have a good answer. The doc tags are used to generate the tutor's pages at http://tutor.rascal-mpl.org, for the standard library and are used by the type checker (to be released) to produce hover help in the IDE. Currently we don't have a process for any project as you described. There should be!

Jurgen Vinju
  • 6,393
  • 1
  • 15
  • 26
1

The required information format of @doc annotations is documented in the Tutor documentation. This information is used to document, for instance, library functions. To give you an impression: the documentation about the Rascal functions on Lists is generated from the source code of the List module found here.

The same information structure is used for complete Tutor pages. For instance, the file Rascal.concept results in this Main page of the Rascal tutorial.

There are some cavests:

  • The @doc tags are not yet used consistently across the code base.
  • Hover support for the @doc information is still missing in the IDE.
Paul Klint
  • 1,418
  • 7
  • 12