Skip to content

Commit 020ef19

Browse files
author
Vladimir Kotal
committed
fix javadoc
1 parent ab973ad commit 020ef19

24 files changed

+54
-38
lines changed

src/org/opensolaris/opengrok/authorization/IAuthorizationPlugin.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,8 @@ public interface IAuthorizationPlugin {
6161
* It is up to the implementor if the standard request attributes like
6262
* session, user principal and others are used or not.
6363
*
64-
* @param request
65-
* @param project
64+
* @param request servlet request
65+
* @param project project to test
6666
* @return true if request is allowed to see this project
6767
*/
6868
boolean isAllowed(HttpServletRequest request, Project project);
@@ -78,8 +78,8 @@ public interface IAuthorizationPlugin {
7878
* projects, repositories. You must include those in the isAllowed method
7979
* for project if you want to display content of the group.
8080
*
81-
* @param request
82-
* @param group
81+
* @param request servlet request
82+
* @param group group to test
8383
* @return true if request is allowed to see this group of projects
8484
*/
8585
boolean isAllowed(HttpServletRequest request, Group group);

src/org/opensolaris/opengrok/configuration/ConfigMerge.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ public class ConfigMerge {
4747
* Merge base and new configuration.
4848
* @param cfgBase base configuration
4949
* @param cfgNew new configuration, will receive properties from the base configuration
50-
* @throws Exception
50+
* @throws Exception exception
5151
*/
5252
public static void merge(Configuration cfgBase, Configuration cfgNew) throws Exception {
5353
Configuration cfgDefault = new Configuration();

src/org/opensolaris/opengrok/configuration/RuntimeEnvironment.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2029,6 +2029,7 @@ public void maybeRefreshIndexSearchers() {
20292029
*
20302030
* @param proj project
20312031
* @return SearcherManager for given project
2032+
* @throws IOException I/O exception
20322033
*/
20332034
public SuperIndexSearcher getIndexSearcher(String proj) throws IOException {
20342035
SearcherManager mgr = searcherManagerMap.get(proj);

src/org/opensolaris/opengrok/configuration/messages/Message.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ public abstract class Message implements Comparable<Message> {
7878
*
7979
* @param env the runtime environment
8080
* @return possible output for this application, null if no output
81-
* @throws java.lang.Exception
81+
* @throws java.lang.Exception exception
8282
*/
8383
final public byte[] apply(RuntimeEnvironment env) throws Exception {
8484
validate();
@@ -90,7 +90,7 @@ final public byte[] apply(RuntimeEnvironment env) throws Exception {
9090
*
9191
* @param env the runtime environment
9292
* @return possible output for this application, null if no output
93-
* @throws java.lang.Exception
93+
* @throws java.lang.Exception exception
9494
*/
9595
protected abstract byte[] applyMessage(RuntimeEnvironment env) throws Exception;
9696

@@ -99,7 +99,7 @@ final public byte[] apply(RuntimeEnvironment env) throws Exception {
9999
* valid. Further implementation can override this method to get the message
100100
* into a state they would expect.
101101
*
102-
* @throws Exception
102+
* @throws Exception exception
103103
*/
104104
public void validate() throws Exception {
105105
if (getCreated() == null) {
@@ -280,7 +280,7 @@ public boolean equals(Object obj) {
280280
*
281281
* @param host host
282282
* @param port port number
283-
* @throws IOException
283+
* @throws IOException if I/O exception occurred
284284
*
285285
* @see #throwIfError(int c, String message)
286286
*

src/org/opensolaris/opengrok/configuration/messages/ProjectMessage.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -295,7 +295,7 @@ protected byte[] applyMessage(RuntimeEnvironment env) throws Exception {
295295
/**
296296
* Validate ProjectMessage.
297297
* Tags are project names, text is command (add/delete)
298-
* @throws Exception
298+
* @throws Exception exception
299299
*/
300300
@Override
301301
public void validate() throws Exception {

src/org/opensolaris/opengrok/configuration/messages/RepositoryMessage.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ protected byte[] applyMessage(RuntimeEnvironment env) throws Exception {
7070
/**
7171
* Validate the message.
7272
* Tag is repository path, text is command.
73-
* @throws Exception
73+
* @throws Exception exception
7474
*/
7575
@Override
7676
public void validate() throws Exception {

src/org/opensolaris/opengrok/history/BazaarRepository.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ public InputStream getHistoryGet(String parent, String basename, String rev) {
160160
* @param file file to annotate
161161
* @param revision revision to annotate
162162
* @return file annotation
163-
* @throws java.io.IOException
163+
* @throws java.io.IOException if I/O exception occurred
164164
*/
165165
@Override
166166
public Annotation annotate(File file, String revision) throws IOException {

src/org/opensolaris/opengrok/history/ClearCaseRepository.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ private static void drainStream(InputStream in) throws IOException {
205205
* @param file file to annotate
206206
* @param revision revision to annotate
207207
* @return file annotation
208-
* @throws java.io.IOException
208+
* @throws java.io.IOException if I/O exception occurred
209209
*/
210210
@Override
211211
public Annotation annotate(File file, String revision) throws IOException {

src/org/opensolaris/opengrok/history/GitRepository.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -299,7 +299,7 @@ public String get() {
299299
* @param fullpath file path
300300
* @param changeset changeset
301301
* @return original filename
302-
* @throws java.io.IOException
302+
* @throws java.io.IOException if I/O exception occurred
303303
*/
304304
protected String findOriginalName(String fullpath, String changeset)
305305
throws IOException {
@@ -374,7 +374,7 @@ protected String findOriginalName(String fullpath, String changeset)
374374
* @param file file to annotate
375375
* @param revision revision to annotate
376376
* @return file annotation
377-
* @throws java.io.IOException
377+
* @throws java.io.IOException if I/O exception occurred
378378
*/
379379
@Override
380380
public Annotation annotate(File file, String revision) throws IOException {

src/org/opensolaris/opengrok/history/HistoryEntry.java

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,10 @@ public HistoryEntry() {
6262
changeRequests = new ArrayList<String>();
6363
}
6464

65-
/** Copy constructor */
65+
/**
66+
* Copy constructor
67+
* @param that HistoryEntry object
68+
*/
6669
public HistoryEntry(HistoryEntry that) {
6770
this.revision = that.revision;
6871
this.date = that.date;

0 commit comments

Comments
 (0)