From e394656f1b5a6222e9739f3d2e6bef2707ae0526 Mon Sep 17 00:00:00 2001 From: Dominik Helm Date: Fri, 26 Jan 2024 13:47:21 +0100 Subject: [PATCH 1/3] HTML fixes --- src/site/DeveloperTools.md | 36 ++++++++++++++--------------- src/site/defaultTemplate.scala.html | 2 +- 2 files changed, 19 insertions(+), 19 deletions(-) diff --git a/src/site/DeveloperTools.md b/src/site/DeveloperTools.md index 800728327e..0e89f5fa06 100644 --- a/src/site/DeveloperTools.md +++ b/src/site/DeveloperTools.md @@ -15,27 +15,27 @@ In contrast to most existing Java disassemblers, OPAL generates an HTML document 
 Usage: java org.opalj.da.Disassembler
-       [-help will print the help and terminate]
-       [-o <File> the name of the file to which the generated html page should be written]
-       [-open the generated html page will be opened in a browser]
-       [-source <File> a class or jar file or a directory containing jar or class files;
+       [-help will print the help and terminate]
+       [-o <File> the name of the file to which the generated html page should be written]
+       [-open the generated html page will be opened in a browser]
+       [-source <File> a class or jar file or a directory containing jar or class files;
                      if no source files/folders are specified the current folder will be
-                     searched for class files]* (can be specified multiple times)
-       [-sourceJDK the current JDK/JRE is added as a source folder]
-       [-noDefaultCSS the generated html page will have no CSS styling]
-       [-noMethodsFilter the generated html page will have no embedded means to filter methods
-                       (as a whole, the file will not contain any JavaScript code)]
-       [-noHeader the generated output will have no header;
+                     searched for class files]* (can be specified multiple times)
+       [-sourceJDK the current JDK/JRE is added as a source folder]
+       [-noDefaultCSS the generated html page will have no CSS styling]
+       [-noMethodsFilter the generated html page will have no embedded means to filter methods
+                       (as a whole, the file will not contain any JavaScript code)]
+       [-noHeader the generated output will have no header;
                  the top level element will be <div class="class_file">...</div>
-                 (automatically activates "-noMethodsFilter" and "-noDefaultCSS")]
-       [-css <Source> the path (URL) of a CSS file (".csss")
-                     which will be referenced from the generated HTML page]
-       [-js <Source> the path (URL) of a JavaScript file (".js")
-                    which will be referenced from the generated HTML page]
-       [-showProgress shows the progress when searching for the class file]
-       [<ClassName> name of the class for which we want to create the HTML page; if not
+                 (automatically activates "-noMethodsFilter" and "-noDefaultCSS")]
+       [-css <Source> the path (URL) of a CSS file (".csss")
+                     which will be referenced from the generated HTML page]
+       [-js <Source> the path (URL) of a JavaScript file (".js")
+                    which will be referenced from the generated HTML page]
+       [-showProgress shows the progress when searching for the class file]
+       [<ClassName> name of the class for which we want to create the HTML page; if not
                    specified the first class that is found on the given path is taken; this
-                   is particularly useful if the source identifies a particular ".class" file]
+                   is particularly useful if the source identifies a particular ".class" file]
Note, that the OPAL Disassembler is fast and can scan thousands of class files per second; this makes it also possible to use it to locate a certain class file. For example, if you want to find the jar which defines a specific class, e.g., `java.util.HashMap$Entry`, it is sufficient to specify the root folder of the JDK and let it automatically find the class for you. The generated HTML file will contain precise information where the class file was found. This also works if you specify the root of your `.ivy` or `.m2` folders. diff --git a/src/site/defaultTemplate.scala.html b/src/site/defaultTemplate.scala.html index 439be5f116..95c0912de1 100644 --- a/src/site/defaultTemplate.scala.html +++ b/src/site/defaultTemplate.scala.html @@ -77,7 +77,7 @@

Related

Supported By