Skip to content

Commit 37f7916

Browse files
Update javadocs to specify full path of classes
Original Pull Request #71 Closes #50
1 parent dfd35db commit 37f7916

14 files changed

+28
-26
lines changed

src/main/java/io/vanslog/spring/data/meilisearch/client/ClientConfigurationBuilder.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
import org.springframework.util.Assert;
2121

2222
/**
23-
* A builder for Meilisearch {@link ClientConfiguration}.
23+
* A builder for Meilisearch {@link io.vanslog.spring.data.meilisearch.client.ClientConfiguration}.
2424
*
2525
* @author Junghoon Ban
2626
*/
@@ -81,9 +81,9 @@ public ClientConfigurationBuilder withClientAgents(String[] clientAgents) {
8181
}
8282

8383
/**
84-
* Build a {@link ClientConfiguration} with the given parameters.
84+
* Build a {@link io.vanslog.spring.data.meilisearch.client.ClientConfiguration} with the given parameters.
8585
*
86-
* @return {@link ClientConfiguration}
86+
* @return {@link io.vanslog.spring.data.meilisearch.client.ClientConfiguration}
8787
*/
8888
public ClientConfiguration build() {
8989
Assert.notNull(this.hostUrl, "Host URL must not be null");

src/main/java/io/vanslog/spring/data/meilisearch/client/DefaultClientConfiguration.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
import com.meilisearch.sdk.json.JsonHandler;
2323

2424
/**
25-
* Default implementation of {@link ClientConfiguration}.
25+
* Default implementation of {@link io.vanslog.spring.data.meilisearch.client.ClientConfiguration}.
2626
*
2727
* @author Junghoon Ban
2828
*/

src/main/java/io/vanslog/spring/data/meilisearch/client/MeilisearchClientFactoryBean.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@
2525
import com.meilisearch.sdk.json.JsonHandler;
2626

2727
/**
28-
* FactoryBean class that creates a Meilisearch {@link Client}. The Meilisearch client is created by setting the host
29-
* URL, API key, JSON handler, and client agents.
28+
* FactoryBean class that creates a Meilisearch {@link com.meilisearch.sdk.Client}. The Meilisearch client is created by
29+
* setting the host URL, API key, JSON handler, and client agents.
3030
*
3131
* @author Junghoon Ban
3232
* @see Client

src/main/java/io/vanslog/spring/data/meilisearch/config/MeilisearchConfiguration.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ public abstract class MeilisearchConfiguration extends MeilisearchConfigurationS
3838
/**
3939
* Create a Meilisearch client configuration.
4040
*
41-
* @return {@link ClientConfiguration}
41+
* @return {@link io.vanslog.spring.data.meilisearch.client.ClientConfiguration}
4242
*/
4343
@Bean(name = "meilisearchClientConfiguration")
4444
public abstract ClientConfiguration clientConfiguration();
@@ -56,12 +56,12 @@ public Client meilisearchClient(ClientConfiguration clientConfiguration, JsonHan
5656
}
5757

5858
/**
59-
* Create a {@link MeilisearchOperations} bean.
59+
* Create a {@link io.vanslog.spring.data.meilisearch.core.MeilisearchOperations} bean.
6060
*
6161
* @param client the Meilisearch client
6262
* @param meilisearchConverter the Meilisearch converter
6363
* @param clientConfiguration the client configuration
64-
* @return the created {@link MeilisearchOperations} bean.
64+
* @return the created {@link io.vanslog.spring.data.meilisearch.core.MeilisearchOperations} bean.
6565
*/
6666
@Bean(name = { "meilisearchOperations", "meilisearchTemplate" })
6767
public MeilisearchOperations meilisearchOperations(Client client, MeilisearchConverter meilisearchConverter,
@@ -70,7 +70,7 @@ public MeilisearchOperations meilisearchOperations(Client client, MeilisearchCon
7070
}
7171

7272
/**
73-
* Register a {@link JsonHandler} bean.
73+
* Register a {@link com.meilisearch.sdk.json.JsonHandler} bean.
7474
*
7575
* @return {@link com.meilisearch.sdk.json.JsonHandler}
7676
*/

src/main/java/io/vanslog/spring/data/meilisearch/config/MeilisearchConfigurationSupport.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@
3333
public class MeilisearchConfigurationSupport {
3434

3535
/**
36-
* Create a {@link MeilisearchConverter} bean.
36+
* Create a {@link io.vanslog.spring.data.meilisearch.core.convert.MeilisearchConverter} bean.
3737
*
3838
* @param meilisearchMappingContext the {@link SimpleMeilisearchMappingContext} to use
39-
* @return the created {@link MeilisearchConverter} bean.
39+
* @return the created {@link io.vanslog.spring.data.meilisearch.core.convert.MeilisearchConverter} bean.
4040
*/
4141
@Bean
4242
public MeilisearchConverter meilisearchConverter(SimpleMeilisearchMappingContext meilisearchMappingContext) {
@@ -45,9 +45,9 @@ public MeilisearchConverter meilisearchConverter(SimpleMeilisearchMappingContext
4545
}
4646

4747
/**
48-
* Create a {@link SimpleMeilisearchMappingContext} bean.
48+
* Create a {@link io.vanslog.spring.data.meilisearch.core.mapping.SimpleMeilisearchMappingContext} bean.
4949
*
50-
* @return the created {@link SimpleMeilisearchMappingContext} bean.
50+
* @return the created {@link io.vanslog.spring.data.meilisearch.core.mapping.SimpleMeilisearchMappingContext} bean.
5151
*/
5252
@Bean
5353
public SimpleMeilisearchMappingContext meilisearchMappingContext() {

src/main/java/io/vanslog/spring/data/meilisearch/core/MeilisearchOperations.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,9 +149,9 @@ public interface MeilisearchOperations {
149149
boolean deleteAll(Class<?> clazz);
150150

151151
/**
152-
* Return the {@link MeilisearchConverter}.
152+
* Return the {@link io.vanslog.spring.data.meilisearch.core.convert.MeilisearchConverter}.
153153
*
154-
* @return {@link MeilisearchConverter}
154+
* @return {@link io.vanslog.spring.data.meilisearch.core.convert.MeilisearchConverter}
155155
*/
156156
MeilisearchConverter getMeilisearchConverter();
157157
}

src/main/java/io/vanslog/spring/data/meilisearch/core/MeilisearchTemplate.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
import com.meilisearch.sdk.model.TaskStatus;
4747

4848
/**
49-
* Implementation of {@link MeilisearchOperations}.
49+
* Implementation of {@link io.vanslog.spring.data.meilisearch.core.MeilisearchOperations}.
5050
*
5151
* @author Junghoon Ban
5252
* @see com.meilisearch.sdk.Client

src/main/java/io/vanslog/spring/data/meilisearch/core/convert/MappingMeilisearchConverter.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@
3030
import org.springframework.util.Assert;
3131

3232
/**
33-
* {@link MeilisearchConverter} Implementation based on {@link MappingContext}.
33+
* {@link io.vanslog.spring.data.meilisearch.core.convert.MeilisearchConverter} Implementation based on
34+
* {@link org.springframework.data.mapping.context.MappingContext}.
3435
*
3536
* @author Junghoon Ban
3637
*/
@@ -43,7 +44,8 @@ public class MappingMeilisearchConverter implements MeilisearchConverter, Applic
4344
@Nullable private ApplicationContext applicationContext;
4445

4546
/**
46-
* Creates a new {@link MappingMeilisearchConverter} given the {@link MappingContext}.
47+
* Creates a new {@link io.vanslog.spring.data.meilisearch.core.convert.MappingMeilisearchConverter} given the
48+
* {@link org.springframework.data.mapping.context.MappingContext}.
4749
*
4850
* @param mappingContext must not be {@literal null}.
4951
*/

src/main/java/io/vanslog/spring/data/meilisearch/core/convert/MeilisearchConverter.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,14 @@
3131
public interface MeilisearchConverter {
3232

3333
/**
34-
* Returns the {@link MappingContext} used by the converter.
34+
* Returns the {@link org.springframework.data.mapping.context.MappingContext}. used by the converter.
3535
*
3636
* @return never {@literal null}.
3737
*/
3838
MappingContext<? extends MeilisearchPersistentEntity<?>, MeilisearchPersistentProperty> getMappingContext();
3939

4040
/**
41-
* Returns the {@link ConversionService} used by the converter.
41+
* Returns the {@link org.springframework.core.convert.ConversionService} used by the converter.
4242
*
4343
* @return never {@literal null}.
4444
*/

src/main/java/io/vanslog/spring/data/meilisearch/core/mapping/MeilisearchPersistentEntity.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
import org.springframework.data.mapping.PersistentEntity;
2020

2121
/**
22-
* Meilisearch specific {@link PersistentEntity} abstraction.
22+
* Meilisearch specific {@link org.springframework.data.mapping.PersistentEntity} abstraction.
2323
*
2424
* @param <T>
2525
* @author Junghoon Ban

0 commit comments

Comments
 (0)