openehr4j / api-generator

Generates Java interface declarations from the openEHR specifications
Apache License 2.0
0 stars 0 forks source link

Replace parsed Java docs with link on class level #14

Open jmewes opened 1 month ago

jmewes commented 1 month ago

e.g.

package org.openehr.rm.ehr_extract.common;

import java.lang.Boolean;
import java.lang.Object;

/**
 * @see <a href="https://specifications.openehr.org/releases/RM/Release-1.1.0/ehr_extract.html#_extract_version_spec_class">EXTRACT_VERSION_SPEC</a>
 */
public interface ExtractVersionSpec {

  Boolean getIncludeAllVersions();

  Object getCommitTimeInterval();

  Boolean getIncludeRevisionHistory();

  Boolean getIncludeData();
}

https://github.com/openehr4j/openehr-rm-4j/blob/master/openehr-rm-ehr-extract/src/main/java/org/openehr/rm/ehr_extract/common/ExtractVersionSpec.java

jmewes commented 1 month ago

It would be great to have a checkstyle rule that verifies that all classes in a project follow this convention.

https://checkstyle.sourceforge.io/writingjavadocchecks.html