tudalgo / AlgoTeX

Die LaTeX-Vorlage der Algo-Gruppe der TU Darmstadt - für FoP und AuD
GNU General Public License v3.0
1 stars 3 forks source link

Referenzieren von JavaDoc Methoden: Fehlende Klammern #15

Closed Oshgnacknak closed 2 years ago

Oshgnacknak commented 2 years ago

Dokumentation (Stand 1cf7fe1061813c9da02c61805a61ff61bb3a890f) kompiliert von

$ pacman -Qi algotex-git
Name                     : algotex-git
Version                  : r86.cda2cdd-1

Folgender Code sollte auf die Methode size() von ArrayList verlinken: https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/ArrayList.html#size()

\refJavaDoc[jdk=11,ref=size]{java.util.ArrayList}

Allerdings fehlen in der erzeugten Url die Klammern, sodass nur auf https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/ArrayList.html#size verlinkt wird. Das Fragment der Url ist damit falsch.

Weiter ist es, wenn nur die Klammern in der Vorlage gesetzt werden sollen, nicht möglich, auf Methoden mit Parametern zu verlinken. Ich sehe zwei möglichkeiten, dass zu fixen:

  1. (In den Docs): Erwähnen, dass Paramtern angegeben werden müssen:
    \refJavaDoc[jdk=11,ref=size()]{java.util.ArrayList}
    % bzw.
    \refJavaDoc[jdk=11,ref=add(int,E)]{java.util.ArrayList}
  2. (In AlgoTex): Optionales Argument params und automatisches Setzen der Klammern:
    \refJavaDoc[jdk=11,ref=size]{java.util.ArrayList}
    % bzw.
    \refJavaDoc[jdk=11,ref=add, params=int,E]{java.util.ArrayList}

    Beide Vorschläge haben noch Probleme mit Kommata.