Skip to content

Add support for generation of varcond documentation - #3977

Open
wadoon wants to merge 7 commits into
mainfrom
weigl/varconddoc
Open

Add support for generation of varcond documentation#3977
wadoon wants to merge 7 commits into
mainfrom
weigl/varconddoc

Conversation

@wadoon

@wadoon wadoon commented Aug 20, 2026

Copy link
Copy Markdown
Member

Intended Change

Let class de.uka.ilkd.key.nparser.varexp.TacletBuilderManipulators#main()
print out Markdown documentation for the current known varconds.

Added therapi-javadoc to write Javadoc into resources to be read at runtime.

Type of pull request

  • New feature (non-breaking change which adds functionality)

Ensuring quality

  • I made sure that introduced/changed code is well documented (javadoc and inline comments).
  • I made sure that new/changed end-user features are well documented (https://github.com/KeYProject/key-docs).
  • I added new test case(s) for new functionality.
  • I have tested the feature as follows: ...
  • I have checked that runtime performance has not deteriorated.
  • For new Gradle modules: I added the Gradle module to the test matrix in
    .github/workflows/tests.yml

@wadoon

wadoon commented Aug 20, 2026

Copy link
Copy Markdown
Member Author

We might want to discuss whether we want to introduce this library https://github.com/dnault/therapi-runtime-javadoc

Which brings annotations and an annotation processor that writes annotations capturing the Javadoc to Clazz and other Java entities for runtime usage

@wadoon
wadoon requested a review from unp1 August 21, 2026 16:08
@wadoon wadoon self-assigned this Aug 21, 2026
@wadoon wadoon added Documentation Improvements or additions to documentation Java Pull requests that update Java code labels Aug 21, 2026
@wadoon wadoon added this to the v3.1.0 milestone Aug 21, 2026

@unp1 unp1 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. No blockers just discussion points.

@wadoon
wadoon requested a review from unp1 August 23, 2026 18:51

@unp1 unp1 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Concerning the failing WD test, that constructor for ConstantCondition takes a JAbstractSortedOperator which is not a parseable variable.

(also "\reference" does not take a variable)

Comment thread key.core/src/main/java/de/uka/ilkd/key/doc/VarcondDoc.java Outdated
Comment thread key.core/src/main/java/de/uka/ilkd/key/doc/VarcondDoc.java Outdated
Comment thread key.core/src/main/java/de/uka/ilkd/key/doc/VarcondDoc.java Outdated
}
};
public static final AbstractConditionBuilder ENUM_TYPE =
new ConstructorBasedBuilder("reference", EnumTypeCondition.class, SV, SV, SV);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

EnumTypeCondition declares only two parameters

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements or additions to documentation Java Pull requests that update Java code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants