Skip to content

Commit

Permalink
JSPWIKI-1135 - Add dependabot config file and Fix JavaDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
arturobernalg committed Dec 23, 2020
1 parent 2b54a92 commit 4ae0a30
Show file tree
Hide file tree
Showing 8 changed files with 37 additions and 7 deletions.
31 changes: 31 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

version: 2
updates:
- package-ecosystem: "maven"
directory: "/"
schedule:
interval: "daily"
ignore:
- dependency-name: javax.servlet:javax.servlet-api
versions: [3.2.0,)
- dependency-name: javax.servlet.jsp:javax.servlet.jsp-api
versions: [2.4.0,)
- dependency-name: org.apache.tomcat:*
versions: [10.0.0,)
- dependency-name: org.slf4j:*
versions: [1.8.0-beta1,2.0.0)

Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ public class Group {
* Protected constructor to prevent direct instantiation except by other
* package members. Callers should use
* {@link GroupManager#parseGroup(String, String, boolean)} or
* {@link GroupManager#parseGroup(org.apache.wiki.WikiContext, boolean)}.
* {@link GroupManager#parseGroup(org.apache.wiki.api.core.Context, boolean)}.
* instead.
* @param name the name of the group
* @param wiki the wiki the group belongs to
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Licensed to the Apache Software Foundation (ASF) under one

/**
* Handles logins made from inside the wiki application, rather than via the web container. This handler is instantiated in
* {@link org.apache.wiki.auth.AuthenticationManager#login(org.apache.wiki.WikiSession,HttpServletRequest, String, String)}.
* {@link org.apache.wiki.auth.AuthenticationManager#login(org.apache.wiki.api.core.Session,HttpServletRequest, String, String)}.
* If container-managed authentication is used, the {@link WebContainerCallbackHandler}is used instead. This callback handler is
* designed to be used with {@link UserDatabaseLoginModule}.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -454,7 +454,7 @@ else if ( action.equalsIgnoreCase( DELETE_ACTION ) )
* </table>
* <p>
* Note that JSPWiki&#8217;s access control checks are made inside of
* {@link org.apache.wiki.auth.AuthorizationManager#checkPermission(org.apache.wiki.WikiSession, Permission)},
* {@link org.apache.wiki.auth.AuthorizationManager#checkPermission(org.apache.wiki.api.core.Session, Permission)},
* which performs a <code>Subject.doAs()</code> call. Thus, this
* Permission functions exactly the way it should during normal
* operations.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,6 @@ public int doWikiStartTag()
*
* @param sb : stringbuilder to write output to
* @param page : start of page block
* @param onclick : link text
*
**/
private void appendLink(final StringBuilder sb, final int page, final String fmttextkey )
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ protected Element containerForModuleDetail( final Element root ) {
}

/**
* Obtains the collection of modules which is going to be inspected at {@link #doGet(WikiContext)}.
* Obtains the collection of modules which is going to be inspected at {@link #doGet(Context)}.
*
* @return a collection of {@link WikiModuleInfo}
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Licensed to the Apache Software Foundation (ASF) under one

/**
* AbstractStep subclass that executes instructions, uninterrupted, and results in an Outcome. Concrete classes only need to implement
* {@link Task#execute()}. When the execution step completes, <code>execute</code> must return {@link Outcome#STEP_COMPLETE},
* {@link Task#execute(org.apache.wiki.api.core.Context)}. When the execution step completes, <code>execute</code> must return {@link Outcome#STEP_COMPLETE},
* {@link Outcome#STEP_CONTINUE} or {@link Outcome#STEP_ABORT}. Subclasses can add any errors by calling the helper method
* {@link AbstractStep#addError(String)}. The execute method should <em>generally</em> capture and add errors to the error list instead of
* throwing a WikiException.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Licensed to the Apache Software Foundation (ASF) under one
* IllegalStateException. Callers can place the Workflow into the WAITING state by calling {@link #waitstate()}.</li>
* <li><strong>{@link #WAITING}</strong>: when the Workflow has temporarily paused, for example because of a pending Decision. Once the
* responsible actor decides what to do, the caller can change the Workflow back to the RUNNING state by calling the {@link #restart(Context)}
* method (this is done automatically by the Decision class, for instance, when the {@link Decision#decide(Outcome)} method is invoked)</li>
* method (this is done automatically by the Decision class, for instance, when the {@link Decision#decide(Outcome, Context)} method is invoked)</li>
* <li><strong>{@link #COMPLETED}</strong>: after the Workflow has finished processing all Steps, without errors.</li>
* <li><strong>{@link #ABORTED}</strong>: if a Step has elected to abort the Workflow.</li>
* </ul>
Expand Down

0 comments on commit 4ae0a30

Please sign in to comment.