Merge pull request #6 from umjammer/1.4.5

1.4.5

Author: umjammer

.github/workflows/codeql-analysis.yml

@@ -38,7 +38,7 @@ jobs:
 
     # If this run was triggered by a pull request event, then checkout
     # the head of the pull request instead of the merge commit.
-    - run: git checkout HEAD^2
+    - run: git checkout HEAD
       if: ${{ github.event_name == 'pull_request' }}
 
     # Initializes the CodeQL tools for scanning.
@@ -51,7 +51,13 @@ jobs:
         # Prefix the list here with "+" to use these queries and those in the config file.
         # queries: ./path/to/local/query, your-org/your-repo/queries@main
 
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    - name: Setup Java JDK
+      uses: actions/[email protected]
+      with:
+        java-version: '17.0.1+12'
+        distribution: 'temurin'
+
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
       uses: github/codeql-action/autobuild@v1

.github/workflows/maven.yml

@@ -9,9 +9,10 @@ jobs:
 
     steps:
     - uses: actions/checkout@v1
-    - name: Set up JDK 1.8
-      uses: actions/setup-java@v1
+    - name: Set up JDK 17
+      uses: actions/setup-java@v2.3.1
       with:
-        java-version: 1.8
+        java-version: '17.0.1+12'
+        distribution: 'temurin'
     - name: Build with Maven
       run: mvn -B package --file pom.xml

CHANGELOG.md

@@ -0,0 +1,39 @@
+# change history
+
+## version 1.4.x
+
+ * update v6 parsing and rendering
+ * enable to parse javadoc on www directly
+
+## version 1.4.0
+
+ * java8 support
+ * java11 support
+ * java12 support
+ * java13 support
+ * i18n support
+ * add unit test
+
+## version 1.3.0
+
+ * java1.5 support for Enums and Generics
+ * java1.6 support for Annotations
+
+## version 1.2.0
+
+ * java1.5 support (except enum and generics)
+
+## version 1.1.0
+
+ * resolve type names to externally linked javadocs. Links to Sun's
+   reference apis are resolved automatically
+   ( i.e. http://java.sun.com/j2se/X/docs/api/ ).
+   Any other links will need to be given as extra parameters for the
+   codavaj command.
+ * significant extentions to the reflection-like API to represent Packages
+   and link Types to their respective Packages and back, and also represent
+   package heirarchy.
+ * fix wrong determination of a class as Interface if "Interface" part of
+   classname.
+
+## initial version 1.0.0

README.md

@@ -1,4 +1,7 @@
-[![](https://jitpack.io/v/umjammer/codavaj.svg)](https://jitpack.io/#umjammer/codavaj) [![Actions Status](https://github.com/umjammer/codavaj/workflows/Java%20CI/badge.svg)](https://github.com/umjammer/codavaj/actions)
+[![Releases](https://jitpack.io/v/umjammer/codavaj.svg)](https://jitpack.io/#umjammer/codavaj)
+[![Actions Status](https://github.com/umjammer/codavaj/actions/workflows/maven.yml/badge.svg)](https://github.com/umjammer/codavaj/actions)
+[![CodeQL](https://github.com/umjammer/codavaj/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/umjammer/codavaj/actions/workflows/codeql-analysis.yml)
+![Java](https://img.shields.io/badge/Java-8-b07219)
 
 # CODAVAJ - ( javadoc in reverse ) README
 
@@ -39,69 +42,24 @@ codavaj.cmd codavaj http://jumpi.sourceforge.net/javadoc/j2se tmp/jumpi/src
 | [JDT](https://www.eclipse.org/jdt/) | ✅ | 🚫 | [📄](https://github.com/umjammer/codavaj/blob/master/src/test/java/Test04.java) |
 | [spoon](https://github.com/INRIA/spoon) | ✅ | 🚫 | [📄](https://github.com/umjammer/codavaj/blob/master/src/test/java/Test05.java) |
 
-## Download (obsoleted, use convert)
-
-to download an entire javadoc tree for further processing use:
-
-```
-codavaj.cmd wget <URL> <destination-dir>
-```
-
-i.e.
-
-```
-codavaj.cmd wget http://jumpi.sourceforge.net/javadoc/j2se tmp/jumpi/javadoc
-```
-
-## change history
-
-version 1.4.x
-
- * update v6 parsing and rendering
- * enable to parse javadoc on www directly
-
-version 1.4.0
-
- * java8 support
- * java11 support
- * java12 support
- * java13 support
- * i18n support
- * add unit test
-
-version 1.3.0
-
- * java1.5 support for Enums and Generics
- * java1.6 support for Annotations
-
-version 1.2.0
-
- * java1.5 support (except enum and generics)
-
-version 1.1.0
-
- * resolve type names to externally linked javadocs. Links to Sun's
-   reference apis are resolved automatically 
-   ( i.e. http://java.sun.com/j2se/X/docs/api/ ). 
-   Any other links will need to be given as extra parameters for the 
-   codavaj command.
- * significant extentions to the reflection-like API to represent Packages
-   and link Types to their respective Packages and back, and also represent
-   package heirarchy.
- * fix wrong determination of a class as Interface if "Interface" part of
-   classname.
-
-initial version 1.0.0
-
 ## known issues
 
-codavaj does not introduce default constructor's if they weren't found
+* codavaj does not introduce default constructor's if they weren't found
 in the javadoc. This leads to compile problems if there are subclasses
 which use the class's default constructor through the implicit super(). 
 
+* hekohtml ~1.19.22
+   * https://mvnrepository.com/artifact/net.sourceforge.nekohtml/nekohtml/1.9.22
+      * https://mvnrepository.com/artifact/xerces/xercesImpl/2.11.0
+   * but 1.19.22 doesn't work with this project currently
+   * so i excluded xerces from dependencies, and add xerces 2.12.2 individually. idk how codeql detect those.
+   * https://sourceforge.net/p/nekohtml/bugs/167/#fdcc
+
 ## TODO
 
  * ~~javadoc 1.8~~
  * javadoc html5
  * ~~javadoc 11~~
- * ~~en test case~~
+ * ~~en test case~~
+ * https://github.com/HtmlUnit/htmlunit-neko
+   * https://github.com/HtmlUnit/htmlunit-neko/security/advisories/GHSA-6jmm-mp6w-4rrg

codavaj.sh

@@ -1,4 +1,4 @@
 #!/bin/bash
-CODAVAJ_HOME=$HOME/src/000/codavaj-1.3.0
+CODAVAJ_HOME=$(pwd)
 CP=$(/usr/local/bin/classpath $CODAVAJ_HOME/codavaj-*.jar $CODAVAJ_HOME/lib/*.jar)
 java -classpath $CP org.codavaj.Main $@