codeql icon indicating copy to clipboard operation
codeql copied to clipboard

Published 20 hours ago • verified publisher icon github

Library API Index documentation is incomplete

Open Marcono1234 opened this issue 3 years ago • 1 comments
trafficstars

Description

It appears the Index page of the CodeQL classes for a language seems to be incomplete, at least for Java. It does not include all CodeQL classes and predicates. I think it was always incomplete for data flow related classes, but now it is also missing "regular" classes like AddExpr. The classes can still be found with the Search feature, but do not appear on the Index page.

Is this intended?

Reproduction steps

  1. Open https://codeql.github.com/codeql-standard-libraries/java/index.html
  2. Try to find AddExpr in the list :x: Bug: It is not in the list
  3. Compare this with the archived version of the page: https://web.archive.org/web/20211022203300/https://codeql.github.com/codeql-standard-libraries/java/index.html ✔️ AddExpr is in the list

Marcono1234 avatar Aug 28 '22 21:08 Marcono1234

Additionally, the list of "Known direct subtypes" seems to be incomplete. For ConstructorCall it only lists ClassInstanceExpr, even though SuperConstructorInvocationStmt is a subtype as well.

Not sure if this is the same underlying issue and whether this problem is actually new or existed previously as well.

Marcono1234 avatar Sep 08 '22 18:09 Marcono1234

It seems this has been fixed.

intrigus-lgtm avatar Oct 11 '22 15:10 intrigus-lgtm

It seems this has been fixed.

Is it really? I am still experiencing the missing classes for version 0.4.1.

Marcono1234 avatar Oct 14 '22 22:10 Marcono1234

It seems this has been fixed.

Is it really? I am still experiencing the missing classes for version 0.4.1.

I could swear that when I looked at it, this had been fixed. I'm not 100 percent sure, but I believe I looked at version 0.4.0.

Judging by the last-modified header, the site changed on Tue, 11 Oct 2022 18:03:24 GMT. So it's possible that I indeed looked at a fixed version? Still, this would not make much sense. (Why should it be fixed in the previous version, but not the current version???)

intrigus-lgtm avatar Oct 15 '22 20:10 intrigus-lgtm

The documentation generator has been fixed so this should be fixed in the next release.

alexet avatar Nov 08 '22 17:11 alexet

Thanks! The "Known direct subtypes" for ConstructorCall seem to be fixed, but the Index still does not list AddExpr anymore. Is that intended (given that other similar classes such as ArrayCreationExpr are listed)?

Edit: Looks like this is completely fixed now; AddExpr is now in the index list as well.

Marcono1234 avatar Nov 14 '22 23:11 Marcono1234