Skip to content

Commit

Permalink
adocs updated
Browse files Browse the repository at this point in the history
  • Loading branch information
verhas committed Nov 3, 2023
1 parent 7950407 commit f281dce
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 16 deletions.
3 changes: 2 additions & 1 deletion RELEASES.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@
* The `jamal-prog` package contains a macro `decimal` to support `BigDecimal` calculation in BASIC code.
* The `replace` and `replaceLines` macros in the snippet package result in error not only if the input was not changed, but also when some of the search/replace string-string or regular expression-string pairs made no effect on the input when the option `detectNoChange` is used.
This helps to avoid situations when a snippet is heavily transformed to create documentation lines from source code and the source changes structurally and the transformation gets outdated.
It is recommended to set the `detectNoChange` option to true globally at the start of the input file.w33
It is recommended to set the `detectNoChange` option to true globally at the start of the input file.
* The argument splitting many built-in macro uses now looks at the macro `$REGEX` and uses it to split the arguments if defined.

== https://github.com/verhas/jamal/tree/2.4.0[2.4.0]

Expand Down
7 changes: 1 addition & 6 deletions documentation/FILE_NAMES.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
s////
////
= Resource Files and Web Resources

Macros can reference files.
Expand Down Expand Up @@ -189,7 +187,4 @@ For more information read the link:../jamal-maven-input/README.adoc[documentatio
Jamal can read files from JAR files.
In this case the prefix has to be `jar:file:` and the file name has to be the name of the JAR file followed by the name of the file inside the JAR file following a `!` character.

For more information read the link:../jamal-jar-input/README.adoc[documentation] of the module implementing the `jar:file:` prefix.



For more information read the link:../jamal-jar-input/README.adoc[documentation] of the module implementing the `jar:file:` prefix.
2 changes: 1 addition & 1 deletion documentation/HOWTO_DEBUG.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -118,4 +118,4 @@ If you do not want to trace anymore, do not forget to unset the environment vari
unset JAMAL_TRACE
----

to avoid an excessively large trace file growing on your disk.
to avoid an excessively large trace file growing on your disk.
2 changes: 1 addition & 1 deletion documentation/JAMAL_API.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -103,4 +103,4 @@ The two static methods `include()` and `exclude()` can be used to create these a

The current and past versions of the JavaDoc can be read online at the address:

link:https://javadoc.io/doc/com.javax0.jamal[`https://javadoc.io/doc/com.javax0.jamal`]
link:https://javadoc.io/doc/com.javax0.jamal[`https://javadoc.io/doc/com.javax0.jamal`]
5 changes: 1 addition & 4 deletions documentation/MODULES.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,4 @@ The code in the directory `jamal-debug-ui` contains the REACT.js based ui for th


This is not a module.
The code in the directory `jamal-docker` contains a Dockerfile to build a Docker image with Jamal.



The code in the directory `jamal-docker` contains a Dockerfile to build a Docker image with Jamal.
4 changes: 1 addition & 3 deletions documentation/SAMPLE_README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,4 @@


How to use Jamal in five minutes.
This is a sample readme of the version `2.5.0-SNAPSHOT`.


This is a sample readme of the version `2.5.0-SNAPSHOT`.

0 comments on commit f281dce

Please sign in to comment.