Skip to content

Commit 3a1f97a

Browse files
author
Troy Melhase
committed
Completes links between translation and customization docs.
1 parent a2202a4 commit 3a1f97a

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

doc/translation.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -93,14 +93,14 @@ In the case of interfaces, the strategy is configurable. By default,
9393
interfaces are translated to classes utilizing the `ABCMeta` class. The
9494
package includes config handlers that can translate to simple classes
9595
(inheriting from `object`), or from Zope Interfaces. Interface base types are
96-
controlled via the `interfaceBaseHandlers` config item. The
97-
`interfaceHeadHandlers` config item controls the metaclass.
96+
controlled via the [`interfaceBaseHandlers`][2] config item. The
97+
[`interfaceHeadHandlers`][3] config item controls the metaclass.
9898

9999
Enums are also translated via a configurable strategy. By default, enumerated
100100
values are created as class attributes with string values. The package
101101
includes a config handler to create class attributes with integer values. The
102102
config handler that controls enumeration value construction is
103-
`enumValueHandler`.
103+
[`enumValueHandler`][4].
104104

105105

106106
### Statements
@@ -145,8 +145,8 @@ form:
145145
...
146146

147147
The `lock_for_object` callable is the default and can be controlled via the
148-
`methodLockFunctionName` config item. Also of note, the default
149-
`modulePrologueHandlers` uses a generator named `maybeSyncHelpers` to include
148+
[`methodLockFunctionName`][5] config item. Also of note, the default
149+
[`modulePrologueHandlers`][6] uses a generator named `maybeSyncHelpers` to include
150150
Python helper code for synchronization.
151151

152152
#### return
@@ -219,15 +219,15 @@ corresponding method.
219219

220220
When used as a method or static method annotation, the `synchronized` keyword
221221
is translated to a `@synchronized` method decorator. This behavior is
222-
controllable via the `methodPrologueHandlers` config item.
222+
controllable via the [`methodPrologueHandlers`][7] config item.
223223

224224
See the note above regarding the use of `synchronized` within blocks.
225225

226226
### Comments
227227

228228
Both Java end-of-line comments and multi-line comments are translated to Python
229229
comments. The comment prefix is `# ` (hash plus space) by default, and is
230-
controllable via the `commentPrefix` config item.
230+
controllable via the [`commentPrefix`][8] config item.
231231

232232
#### JavaDoc
233233

@@ -238,7 +238,12 @@ JavaDoc comments are preserved as Python comments.
238238

239239
Java language specification: http://java.sun.com/docs/books/jls/third_edition/html/syntax.html
240240

241-
242-
243241

244242
[1]: https://github.com/natural/java2python/tree/master/doc/customization.md#astTransforms
243+
[2]: https://github.com/natural/java2python/tree/master/doc/customization.md#interfaceBaseHandlers
244+
[3]: https://github.com/natural/java2python/tree/master/doc/customization.md#interfaceHeadHandlers
245+
[4]: https://github.com/natural/java2python/tree/master/doc/customization.md#enumValueHandler
246+
[5]: https://github.com/natural/java2python/tree/master/doc/customization.md#methodLockFunctionName
247+
[6]: https://github.com/natural/java2python/tree/master/doc/customization.md#modulePrologueHandlers
248+
[7]: https://github.com/natural/java2python/tree/master/doc/customization.md#methodPrologueHandlers
249+
[8]: https://github.com/natural/java2python/tree/master/doc/customization.md#commentPrefix

0 commit comments

Comments
 (0)