Skip to content

Commit c83bb89

Browse files
committed
Javadoc fixes
1 parent 5a2b600 commit c83bb89

8 files changed

Lines changed: 49 additions & 7 deletions

File tree

src/main/java/com/atomgraph/linkeddatahub/client/LinkedDataClient.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,9 @@ public class LinkedDataClient extends com.atomgraph.core.client.LinkedDataClient
4040

4141
private static final Logger log = LoggerFactory.getLogger(LinkedDataClient.class);
4242

43+
/**
44+
* <samp>User-Agent</samp> request header value used by this HTTP client.
45+
*/
4346
public final static String USER_AGENT = "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:107.0) Gecko/20100101 Firefox/107.0"; // impersonate Firefox
4447

4548
private URI baseURI;

src/main/java/com/atomgraph/linkeddatahub/resource/Generate.java

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,16 @@ public Response post(Model model, @QueryParam("default") @DefaultValue("false")
169169
}
170170
}
171171

172-
public Resource createContainerSelect(Model model, String title, Query query, Resource service)
172+
/**
173+
* Creates <code>SELECT</code> SPARQL query.
174+
*
175+
* @param model RDF model
176+
* @param title query title
177+
* @param query query object
178+
* @param service SPARQL service resource
179+
* @return query resource
180+
*/
181+
public Resource createContainerSelect(Model model, String title, Query query, Resource service)
173182
{
174183
return model.createResource().
175184
addProperty(RDF.type, SP.Select).
@@ -178,6 +187,16 @@ public Resource createContainerSelect(Model model, String title, Query query, Re
178187
addProperty(LDH.service, service);
179188
}
180189

190+
/**
191+
* Creates a container document.
192+
*
193+
* @param model RDF model
194+
* @param graphURI named graph URI
195+
* @param parent parent document resource
196+
* @param title document title
197+
* @param content document content
198+
* @return container resource
199+
*/
181200
public Resource createContainer(Model model, URI graphURI, Resource parent, String title, Resource content)
182201
{
183202
return model.createResource(graphURI.toString()).
@@ -189,6 +208,13 @@ public Resource createContainer(Model model, URI graphURI, Resource parent, Stri
189208
addProperty(ResourceFactory.createProperty(RDF.getURI(), "_1"), content);
190209
}
191210

211+
/**
212+
* Creates content resource.
213+
*
214+
* @param model RDF model
215+
* @param query query resource
216+
* @return content resource
217+
*/
192218
public Resource createContent(Model model, Resource query)
193219
{
194220
return model.createResource().

src/main/java/com/atomgraph/linkeddatahub/server/exception/RDFSyntaxException.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@
3030
* Thrown when read RDF data contains a syntax error.
3131
*
3232
* @author Martynas Jusevičius {@literal <martynas@atomgraph.com>}
33-
* @see com.atomgraph.server.io.SkolemizingModelProvider
3433
*/
3534
public class RDFSyntaxException extends ModelException
3635
{

src/main/java/com/atomgraph/linkeddatahub/server/io/CollectingErrorHandler.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@
2525
* Collects syntax errors reported by the RDF parser.
2626
*
2727
* @author Martynas Jusevičius {@literal <martynas@atomgraph.com>}
28-
* @see com.atomgraph.server.io.SkolemizingModelProvider
2928
*/
3029
public class CollectingErrorHandler implements org.apache.jena.riot.system.ErrorHandler
3130
{

src/main/java/com/atomgraph/linkeddatahub/server/model/impl/GraphStoreImpl.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -490,8 +490,8 @@ public Response delete(@QueryParam("default") @DefaultValue("false") Boolean def
490490
* List allowed HTTP methods for the given graph URI.
491491
* Exceptions apply to the application's Root document, owner's WebID document, and secretary's WebID document.
492492
*
493-
* @param graphUri
494-
* @return
493+
* @param graphUri ma,ed graph URI
494+
* @return list of HTTP methods
495495
*/
496496
public Set<String> getAllowedMethods(URI graphUri)
497497
{

src/main/java/com/atomgraph/linkeddatahub/vocabulary/DH.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,14 +46,16 @@ public static String getURI()
4646
/** <p>The namespace of the vocabulary as a resource</p> */
4747
public static final Resource NAMESPACE = m_model.createResource( NS );
4848

49+
/** Document class */
4950
public static final OntClass Document = m_model.createClass( NS + "Document" );
5051

52+
/** Container class */
5153
public static final OntClass Container = m_model.createClass( NS + "Container" );
5254

55+
/** Item class */
5356
public static final OntClass Item = m_model.createClass( NS + "Item" );
5457

58+
/** Slug property */
5559
public static final DatatypeProperty slug = m_model.createDatatypeProperty( NS + "slug" );
5660

57-
public static final ObjectProperty select = m_model.createObjectProperty( NS + "select");
58-
5961
}

src/main/java/com/atomgraph/linkeddatahub/vocabulary/SIOC.java

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,17 @@ public class SIOC {
4141
*/
4242
public static final String NS = "http://rdfs.org/sioc/ns#";
4343

44+
/**
45+
* Default prefix for this namespace.
46+
*/
4447
public static final String PREFIX = "sioc";
4548

4649
/**
4750
* <p>
4851
* The namespace of the vocabulary as a string
4952
* </p>
5053
*
54+
* @return the URI of this namespace
5155
* @see #NS
5256
*/
5357
public static String getURI() {
@@ -154,6 +158,9 @@ public static String getURI() {
154158
public static final ObjectProperty FUNCTION_OF = m_model
155159
.createObjectProperty("http://rdfs.org/sioc/ns#function_of");
156160

161+
/**
162+
* This property has been renamed. Use <samp>sioc:sioc:usergroup_of</samp> instead.
163+
*/
157164
public static final ObjectProperty GROUP_OF = m_model
158165
.createObjectProperty("http://rdfs.org/sioc/ns#group_of");
159166

@@ -197,6 +204,9 @@ public static String getURI() {
197204
public static final ObjectProperty HAS_FUNCTION = m_model
198205
.createObjectProperty("http://rdfs.org/sioc/ns#has_function");
199206

207+
/**
208+
* This property has been renamed. Use <samp>sioc:has_usergroup</samp> instead.
209+
*/
200210
public static final ObjectProperty HAS_GROUP = m_model
201211
.createObjectProperty("http://rdfs.org/sioc/ns#has_group");
202212

src/main/java/com/atomgraph/linkeddatahub/writer/function/Reserialize.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,9 @@
4646
public class Reserialize implements ExtensionFunction
4747
{
4848

49+
/**
50+
* The RDF syntax language used by this function.
51+
*/
4952
public static Lang LANG = Lang.RDFXML;
5053

5154
private final Processor processor;

0 commit comments

Comments
 (0)