io7m-com / cedarbridge

Cedarbridge message protocol specification language
https://www.io7m.com/software/cedarbridge
ISC License
0 stars 0 forks source link

Javadoc doesn't validate #20

Closed io7m closed 2 years ago

io7m commented 2 years ago

The generator generates code that doesn't pass JavaDoc validation:

/**
 * A serializer for color values.
 */

public final class IdColorSerializer
  extends StdSerializer<IdColor>
{
  /**
   * A serializer for color values.
   *
   * @inheritDoc
   */

  public IdColorSerializer()
  {
    this(null);
  }

  /**
   * A serializer for color values.
   *
   * @inheritDoc
   *
   * @param t The serialized class
   */

  public IdColorSerializer(
    final Class<IdColor> t)
  {
    super(t);
  }
Generating /home/build/git/com.github/io7m/idstore/com.io7m.idstore.documentation/target/documentation/apidocs/com/io7m/idstore/colors/IdColorSerializer.html...
/home/build/git/com.github/io7m/idstore/com.io7m.idstore.documentation/target/javadoc-sources/com/io7m/idstore/colors/IdColorSerializer.java:36: error: incorrect use of inline tag
   * @inheritDoc
     ^
/home/build/git/com.github/io7m/idstore/com.io7m.idstore.documentation/target/javadoc-sources/com/io7m/idstore/colors/IdColorSerializer.java:48: error: incorrect use of inline tag
   * @inheritDoc
     ^
io7m commented 2 years ago

Filed on wrong project.