Skip to content

Commit 209a6d2

Browse files
authored
docs: Fix broken links and formatting issues in documentation (#1396)
2 parents a77499e + 761ab8a commit 209a6d2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+753
-987
lines changed

docs/config.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ the `org.seasar.doma.jdbc.Config` interface.
1414
Return a JDBC `DataSource` from the `getDataSource` method.
1515
If you need to use local transactions provided by Doma, return a `LocalTransactionDataSource`.
1616

17-
See also: [](transaction.md)
17+
See also: [Transaction](transaction.md)
1818

1919
:::{note}
2020
This is a required configuration item.
@@ -147,7 +147,7 @@ The default MapKeyNaming does nothing.
147147
Return a `LocalTransactionManager` from the `getTransactionManager` method.
148148
By default, the `getTransactionManager` method throws `UnsupportedOperationException`.
149149

150-
See also: [](transaction.md)
150+
See also: [Transaction](transaction.md)
151151

152152
### Adding SQL identifiers to SQLs as comments
153153

@@ -172,23 +172,23 @@ For example, the QueryImplementors provides a hook to rewrite SQL statements.
172172
### Query timeout
173173

174174
Return the query timeout (in seconds) from the `getQueryTimeout` method.
175-
This value is used as the default in [](query/index.md).
175+
This value is used as the default in [Queries](query/index.md).
176176

177177
### Max rows
178178

179179
Return the max rows from the `getMaxRows` method.
180-
This value is used as the default in [](query/select.md).
180+
This value is used as the default in [Select](query/select.md).
181181

182182
### Fetch size
183183

184184
Return the fetch size from the `getFetchSize` method.
185-
This value is used as the default in [](query/select.md).
185+
This value is used as the default in [Select](query/select.md).
186186

187187
### Batch size
188188

189189
Return the batch size from the `getBatchSize` method.
190-
This value is used as the default in [](query/batch-insert.md),
191-
[](query/batch-update.md) and [](query/batch-delete.md).
190+
This value is used as the default in [Batch insert](query/batch-insert.md),
191+
[Batch update](query/batch-update.md) and [Batch delete](query/batch-delete.md).
192192

193193
### Providing entity listeners
194194

docs/criteria-api.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
## Introduction
88

99
:::{warning}
10-
Please use the Query DSL introduced on the [](query-dsl.md) page instead of the Entityql and NativeSql
10+
Please use the Query DSL introduced on the [Unified Criteria API](query-dsl.md) page instead of the Entityql and NativeSql
1111
DSLs explained here.
1212
The Query DSL is a new, unified interface that combines both Entityql and NativeSql DSLs.
1313
:::
@@ -105,7 +105,7 @@ These metamodels allow you to make your query typesafe.
105105
You can customize the name of the metamodels by the Metamodel annotation elements.
106106

107107
To customize all metamodels in bulk, you can use the annotation processor options.
108-
See [](annotation-processing.md) and check the following options:
108+
See [Annotation Processing](annotation-processing.md) and check the following options:
109109

110110
- doma.metamodel.enabled
111111
- doma.metamodel.prefix
@@ -1157,7 +1157,7 @@ order by
11571157

11581158
## Delete statement
11591159

1160-
For the specification of the where expression, see [](#criteria-where).
1160+
For the specification of the where expression, see [Criteria Where](#criteria-where).
11611161
The same rule is applied to delete statements.
11621162

11631163
### Delete settings (Entityql, NativeSql)
@@ -1468,7 +1468,7 @@ int count result = nativeSql
14681468

14691469
## Update statement
14701470

1471-
For the specification of the where expression, see [](#criteria-where).
1471+
For the specification of the where expression, see [Criteria Where](#criteria-where).
14721472
The same rule is applied to update statements.
14731473

14741474
### Update settings (Entityql, NativeSql)

docs/dao.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ Implementation classes for the DAO interfaces are automatically generated by the
1414

1515
## Query definition
1616

17-
[](query/index.md) can be defined using annotations.
17+
[Queries](query/index.md) can be defined using annotations.
1818

19-
You can use [](query-builder/index.md) or [](query-dsl.md) in a [](#dao-default-method) when you need to build queries dynamically in Java code.
19+
You can use [Query builders](query-builder/index.md) or [Unified Criteria API](query-dsl.md) in a [Dao Default Method](#dao-default-method) when you need to build queries dynamically in Java code.
2020

2121
(dao-default-method)=
2222

@@ -52,7 +52,7 @@ Employee employee = employeeDao.selectById(1);
5252
```
5353

5454
By default, the implementation class name is the interface name suffixed with `Impl`.
55-
Please refer to [](annotation-processing.md) for information on how to customize the package name and suffix.
55+
Please refer to [Annotation Processing](annotation-processing.md) for information on how to customize the package name and suffix.
5656

5757
A DAO interface does not need to be defined in a one-to-one relationship with an entity class.
5858
One DAO interface can handle multiple entity classes.

docs/domain.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Every domain class is either an internal domain class or an external domain clas
1515

1616
Internal domain classes must be annotated with `@Domain`.
1717
The `valueType` element of the `@Domain` annotation specifies the data type of the corresponding database column.
18-
You must specify a type from [](basic.md) for the `valueType` element.
18+
You must specify a type from [Basic classes](basic.md) for the `valueType` element.
1919

2020
### Instantiation with a constructor
2121

docs/embeddable.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,9 +79,9 @@ By default, all fields are persistent and correspond to database columns or resu
7979

8080
The field type must be one of the following:
8181

82-
- [](basic.md)
83-
- [](domain.md)
84-
- java.util.Optional, whose element is either [](basic.md) or [](domain.md)
82+
- [Basic classes](basic.md)
83+
- [Domain classes](domain.md)
84+
- java.util.Optional, whose element is either [Basic classes](basic.md) or [Domain classes](domain.md)
8585
- java.util.OptionalInt
8686
- java.util.OptionalLong
8787
- java.util.OptionalDouble

docs/entity.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -130,18 +130,18 @@ public class Employee {
130130
}
131131
```
132132

133-
If the `@Table` annotation is not specified, the table name is determined by the [](#naming-convention) .
133+
If the `@Table` annotation is not specified, the table name is determined by the [Naming Convention](#naming-convention) .
134134

135135
## Field definition
136136

137137
By default, all fields in an entity class are persistent and correspond to database columns or result set columns.
138138

139139
The field type must be one of the following:
140140

141-
- [](basic.md)
142-
- [](domain.md)
143-
- [](embeddable.md)
144-
- java.util.Optional, whose element is either [](basic.md) or [](domain.md)
141+
- [Basic classes](basic.md)
142+
- [Domain classes](domain.md)
143+
- [Embeddable classes](embeddable.md)
144+
- java.util.Optional, whose element is either [Basic classes](basic.md) or [Domain classes](domain.md)
145145
- java.util.OptionalInt
146146
- java.util.OptionalLong
147147
- java.util.OptionalDouble
@@ -173,10 +173,10 @@ properties to `false` within the `@Column` annotation:
173173
String employeeName;
174174
```
175175

176-
If the `@Column` annotation is not specified, the column name is determined by the [](#naming-convention) .
176+
If the `@Column` annotation is not specified, the column name is determined by the [Naming Convention](#naming-convention) .
177177

178178
:::{note}
179-
When the field type is [](embeddable.md), you cannot apply the `@Column` annotation to the field.
179+
When the field type is [Embeddable classes](embeddable.md), you cannot apply the `@Column` annotation to the field.
180180
:::
181181

182182
### Id
@@ -199,7 +199,7 @@ Integer id2;
199199
```
200200

201201
:::{note}
202-
When the field type is [](embeddable.md), you cannot apply the `@Id` annotation to the field.
202+
When the field type is [Embeddable classes](embeddable.md), you cannot apply the `@Id` annotation to the field.
203203
:::
204204

205205
(identity-auto-generation)=
@@ -211,7 +211,7 @@ You can instruct Doma to generate id values automatically using the `@GeneratedV
211211
The field type must be one of the following:
212212

213213
- the subclass of java.lang.Number
214-
- [](domain.md), whose value type is the subclass of java.lang.Number
214+
- [Domain classes](domain.md), whose value type is the subclass of java.lang.Number
215215
- java.util.Optional, whose element is either above types
216216
- OptionalInt
217217
- OptionalLong
@@ -291,7 +291,7 @@ The version fields for optimistic locking are represented with the `@Version` an
291291
The field type must be one of the following:
292292

293293
- the subclass of java.lang.Number
294-
- [](domain.md), whose value type is the subclass of java.lang.Number
294+
- [Domain classes](domain.md), whose value type is the subclass of java.lang.Number
295295
- java.util.Optional, whose element is either above types
296296
- OptionalInt
297297
- OptionalLong
@@ -304,7 +304,7 @@ Integer version;
304304
```
305305

306306
:::{note}
307-
When the field type is [](embeddable.md), you cannot apply the `@Version` annotation to the field.
307+
When the field type is [Embeddable classes](embeddable.md), you cannot apply the `@Version` annotation to the field.
308308
:::
309309

310310
### Tenant Id
@@ -318,7 +318,7 @@ String tenantId;
318318
```
319319

320320
:::{note}
321-
When the field type is [](embeddable.md), you cannot apply the `@TenantId` annotation to the field.
321+
When the field type is [Embeddable classes](embeddable.md), you cannot apply the `@TenantId` annotation to the field.
322322
:::
323323

324324
### Transient
@@ -349,7 +349,7 @@ Instead, this annotation is used to define entity relationships within an aggreg
349349

350350
This annotation should be used in conjunction with the aggregate strategy,
351351
ensuring that related entities are treated as a single unit of consistency.
352-
For more details, see [](aggregate-strategy.md).
352+
For more details, see [Aggregate strategies](aggregate-strategy.md).
353353

354354
### OriginalStates
355355

docs/faq.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ You may get the following message, though the file exists:
7878

7979
You can avoid this error by configuring recommended settings for each build tool and IDE.
8080

81-
See [](build.md).
81+
See [Building an application](build.md).
8282

8383
### Do you provide a tool to generate Java code from a database schema?
8484

@@ -107,14 +107,14 @@ There are two ways:
107107
- SQL Templates.
108108
- The Criteria API.
109109

110-
See [](sql.md) and [](query-dsl.md) for detailed information.
110+
See [SQL templates](sql.md) and [Unified Criteria API](query-dsl.md) for detailed information.
111111

112112
### Does Doma support fetching relationships such as one-to-one or one-to-many?
113113

114114
Yes, there are two ways to fetch relationships:
115115

116-
- [](aggregate-strategy.md) with SQL Templates.
117-
- [](query-dsl.md#association) with the Criteria API.
116+
- [Aggregate strategies](aggregate-strategy.md) with SQL Templates.
117+
- [Association](query-dsl.md#association) with the Criteria API.
118118

119119
### Does Doma provide a JDBC connection pooling feature?
120120

docs/getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ standard SQL for insert, update, and delete operations and for writing complex S
7373
## DSL style
7474

7575
In the DSL style, you work with examples in the `boilerplate.java17.repository.EmployeeRepository`
76-
and the [](query-dsl.md) for operations.
76+
and the [Unified Criteria API](query-dsl.md) for operations.
7777

7878
### SELECT
7979

@@ -132,7 +132,7 @@ public void update(Employee employee) {
132132
## DAO style
133133

134134
You can find some examples in `boilerplate.java17.dao.EmployeeDao`.
135-
See [](dao.md) and [](sql.md) for more information.
135+
See [DAO interfaces](dao.md) and [SQL templates](sql.md) for more information.
136136

137137
### SELECT (DAO)
138138

docs/kotlin-support.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ It is recommended to use the Kotlin-specific Criteria API rather than DAO interf
9494
:::
9595

9696
Doma provides `KQueryDsl`, a Criteria API specifically designed for Kotlin.
97-
It is very similar to the `QueryDsl`, which is described in [](query-dsl.md).
97+
It is very similar to the `QueryDsl`, which is described in [Unified Criteria API](query-dsl.md).
9898
The main advantage of `KQueryDsl` is its simplicity.
9999

100100
```kotlin
@@ -128,7 +128,7 @@ dependencies {
128128

129129
### Code Generation
130130

131-
Use [](codegen.md).
131+
Use [Doma CodeGen Plugin](codegen.md).
132132
This plugin supports Kotlin code generation.
133133

134134
### Using kapt in Gradle

docs/locale/ja/LC_MESSAGES/annotation-processing.po

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ msgid ""
2727
"Doma uses the [Pluggable Annotation Processing "
2828
"API](https://www.jcp.org/en/jsr/detail?id=269) at compile time."
2929
msgstr ""
30-
"Doma はコンパイル時に `Pluggable Annotation Processing API "
31-
"<https://www.jcp.org/en/jsr/detail?id=269>`_ を使用します。"
30+
"Doma はコンパイル時に `[Pluggable Annotation Processing API "
31+
"](https://www.jcp.org/en/jsr/detail?id=269) を使用します。"
3232

3333
#: ../../annotation-processing.md:9
3434
msgid ""
@@ -252,8 +252,8 @@ msgid ""
252252
"Use [the compilerArgs "
253253
"property](https://docs.gradle.org/current/dsl/org.gradle.api.tasks.compile.CompileOptions.html#org.gradle.api.tasks.compile.CompileOptions:compilerArgs):"
254254
msgstr ""
255-
"`compilerArgs プロパティ "
256-
"<https://docs.gradle.org/current/dsl/org.gradle.api.tasks.compile.CompileOptions.html#org.gradle.api.tasks.compile.CompileOptions:compilerArgs>`_"
255+
"[compilerArgs プロパティ]("
256+
"https://docs.gradle.org/current/dsl/org.gradle.api.tasks.compile.CompileOptions.html#org.gradle.api.tasks.compile.CompileOptions:compilerArgs)"
257257
" を使用します。"
258258

259259
#: ../../annotation-processing.md
@@ -273,8 +273,8 @@ msgid ""
273273
"Use [the compilerArgs parameter](https://maven.apache.org/plugins/maven-"
274274
"compiler-plugin/examples/pass-compiler-arguments.html):"
275275
msgstr ""
276-
"`compilerArgs パラメータ <https://maven.apache.org/plugins/maven-compiler-"
277-
"plugin/examples/pass-compiler-arguments.html>`_: を使用します。"
276+
"[compilerArgs パラメータ](https://maven.apache.org/plugins/maven-compiler-"
277+
"plugin/examples/pass-compiler-arguments.html): を使用します。"
278278

279279
#: ../../annotation-processing.md:167
280280
msgid "Setting Options in Eclipse"
@@ -290,8 +290,8 @@ msgid ""
290290
"[com.diffplug.eclipse.apt](https://plugins.gradle.org/plugin/com.diffplug.eclipse.apt)"
291291
" and the `processorArgs` property:"
292292
msgstr ""
293-
"Gradle プラグイン `com.diffplug.eclipse.apt "
294-
"<https://plugins.gradle.org/plugin/com.diffplug.eclipse.apt>`_ と "
293+
"Gradle プラグイン [com.diffplug.eclipse.apt]"
294+
"(https://plugins.gradle.org/plugin/com.diffplug.eclipse.apt) と "
295295
"`processorArgs` プロパティを使用します。"
296296

297297
#: ../../annotation-processing.md:212

0 commit comments

Comments
 (0)