Skip to content

Commit 469df81

Browse files
mkoncekmkoncek
committed
Unify manpage format
1 parent f6a4d62 commit 469df81

3 files changed

Lines changed: 45 additions & 44 deletions

File tree

‎manpages/java_remove_annotations.7.adoc‎

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
= java_remove_annotations(7)
2-
:doctype: manpage
3-
:man source: JURAND
4-
:man manual: Jurand
2+
:doctype: manpage
3+
:mansource: JAVA_REMOVE_ANNOTATIONS
4+
:manmanual: Java packaging support
55

66
== NAME
77
java_remove_annotations - remove imports and annotations from Java source files
@@ -10,7 +10,8 @@ java_remove_annotations - remove imports and annotations from Java source files
1010
*%java_remove_annotations* [optional flags] <matcher>... [file path]...
1111

1212
== DESCRIPTION
13-
This macro removes import statements as well as usage of annotations from Java source files. The does the same as *java_remove_imports* and on top of that finds all uses of annotations and matches the content between the '@' symbol and either ending with whitespace or with an opening parethesis '(' (the annotation arguments).
13+
This macro removes import statements as well as usage of annotations from Java source files.
14+
This does the same as *java_remove_imports* and on top of that finds all uses of annotations and matches the content between the '@' symbol and either ending with whitespace or with an opening parethesis '(' (the annotation arguments).
1415

1516
In case of match, the script also removes the block of paretheses that follows the matched annotation, if it is present.
1617

@@ -25,10 +26,14 @@ Arguments can be specified in arbitrary order.
2526
Matcher is one of:
2627

2728
*-n <name>*::
28-
Simple class name to be matched against the simple names of imported symbols. Names are matched for exact equality. Can be specified multiple times.
29+
Simple class name to be matched against the simple names of imported symbols.
30+
Names are matched for exact equality.
31+
Can be specified multiple times.
2932

3033
*-p <pattern>*::
31-
Regex patterns to be matched against imported symbols. Each imported symbol found in the code is matched against each pattern. Can be specified multiple times.
34+
Regex patterns to be matched against imported symbols.
35+
Each imported symbol found in the code is matched against each pattern.
36+
Can be specified multiple times.
3237

3338
Optional flags:
3439

‎manpages/java_remove_imports.7.adoc‎

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
= java_remove_imports(7)
2-
:doctype: manpage
3-
:man source: JURAND
4-
:man manual: Jurand
2+
:doctype: manpage
3+
:mansource: JAVA_REMOVE_IMPORTS
4+
:manmanual: Java packaging support
55

66
== NAME
77
java_remove_imports - remove import statements from Java source files
@@ -10,7 +10,8 @@ java_remove_imports - remove import statements from Java source files
1010
*%java_remove_imports* [optional flags] <matcher>... [file path]...
1111

1212
== DESCRIPTION
13-
This macro removes import statements from Java source files. The script matches all non-whitespace content following the 'import [static]' statement against all patterns provided via the *-p* flag and all simple class names against names provided by the *-n* flag.
13+
This macro removes import statements from Java source files.
14+
The script matches all non-whitespace content following the 'import [static]' statement against all patterns provided via the *-p* flag and all simple class names against names provided by the *-n* flag.
1415

1516
File path arguments are handled the following way:
1617

@@ -23,10 +24,14 @@ Arguments can be specified in arbitrary order.
2324
Matcher is one of:
2425

2526
*-n <name>*::
26-
Simple class name to be matched against the simple names of imported symbols. Names are matched for exact equality. Can be specified multiple times.
27+
Simple class name to be matched against the simple names of imported symbols.
28+
Names are matched for exact equality.
29+
Can be specified multiple times.
2730

2831
*-p <pattern>*::
29-
Regex patterns to be matched against imported symbols. Each imported symbol found in the code is matched against each pattern. Can be specified multiple times.
32+
Regex patterns to be matched against imported symbols.
33+
Each imported symbol found in the code is matched against each pattern.
34+
Can be specified multiple times.
3035

3136
Optional flags:
3237

‎manpages/jurand.1.adoc‎

Lines changed: 23 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,45 @@
1-
jurand(1)
2-
=========
1+
= jurand(1)
32
:doctype: manpage
4-
:manmanual: Jurand Manual
53
:mansource: JURAND
4+
:manmanual: Jurand Manual
65

7-
NAME
8-
----
9-
jurand - Java removal of annotations.
6+
== NAME
7+
jurand - Java removal of annotations
108

11-
SYNOPSIS
12-
--------
13-
*jurand* [*-n*=_<name>_] [*-p*=_<pattern>_] [*-a*] [*-i*] [*-s*] [_<paths>_...]
9+
== SYNOPSIS
10+
*jurand* [*-a*] [*-i*] [*-s*] [*-n*=_<name>_] [*-p*=<pattern>] [_<paths>_...]
1411

15-
DESCRIPTION
16-
-----------
12+
== DESCRIPTION
1713
A tool for manipulating symbols present in `.java` source files.
1814

19-
The tool can be used for patching `.java` sources in cases where using
20-
sed is insufficient due to Java language syntax. The tool follows Java
21-
language rules rather than applying simple regular expressions on the
22-
source code.
15+
The tool can be used for patching `.java` sources in cases where using sed is insufficient due to Java language syntax.
16+
The tool follows Java language rules rather than applying simple regular expressions on the source code.
2317

24-
Currently the tool is able to remove `import` statements and
25-
annotations.
18+
Currently the tool is able to remove `import` statements and annotations.
2619

27-
OPTIONS
28-
-------
20+
== OPTIONS
2921
*-n*, *--name*=_<name>_::
30-
Simple (not fully-qualified) class name.
22+
Simple (not fully-qualified) class name.
3123

3224
*-p*, *--pattern*=_<pattern>_::
33-
Regex pattern to match names used in code.
25+
Regex pattern to match names used in code.
3426

3527
*-a*::
36-
Also remove annotations used in code.
28+
Also remove annotations used in code.
3729

3830
*-i*, *--in-place*::
39-
Replace the contents of files.
31+
Replace the contents of files.
4032

4133
*-s*, *--strict*::
42-
Fail if any of the specified options was redundant and no changes
43-
associated with the option were made. This option is only applicable
44-
together with *-i*.
34+
Fail if any of the specified options was redundant and no changes associated with the option were made.
35+
This option is only applicable together with *-i*.
36+
37+
== REPORTING BUGS
38+
Bugs should be reported through the Jurand issue tracker at Github: https://github.com/fedora-java/jurand/issues.
4539

46-
REPORTING BUGS
47-
--------------
48-
Bugs should be reported through the Jurand issue tracker at Github:
49-
https://github.com/fedora-java/jurand/issues.
40+
== AUTHOR
41+
Written by Marián Konček.
5042

51-
SEE ALSO
52-
--------
43+
== SEE ALSO
5344
*java_remove_annotations*(7),
5445
*java_remove_imports*(7).

0 commit comments

Comments
 (0)