vert-x3 / vertx-docgen

Documentation generation
Apache License 2.0
23 stars 11 forks source link

Provide a way to skip example 'translation' #6

Closed cescoffier closed 9 years ago

cescoffier commented 9 years ago

Sometimes you are including code in your example that must not be translated to other languages. A perfect example of this is the documentation of vertx-unit, because some part a really specific to Java (integration with junit) and does not need to be translated into JavaScript or Groovy. In addition, only the java version should be used in the generated documentation.

For support this feature we could add a translate=false attribute to the @Source annotation. When this attribute is found, the Java version of the code is used regardless the current language.

cescoffier commented 9 years ago

working on it.