Skip to content
This repository has been archived by the owner on Jan 25, 2022. It is now read-only.

Commit

Permalink
Fixed documentation ported from Jenkins' JavaDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
drnic committed Apr 19, 2013
1 parent 5ba29a8 commit b7afcaf
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 12 deletions.
8 changes: 4 additions & 4 deletions ruby-runtime/lib/jenkins/listeners/item_listener.rb
Expand Up @@ -23,7 +23,7 @@ module ItemListener
Jenkins.plugin.register_extension ItemListenerProxy.new(Jenkins.plugin, cls.new)
end

# Called after a new job is created and added to@link jenkins.model.Jenkinsend,
# Called after a new job is created and added to jenkins.model.Jenkins,
# before the initial configuration page is provided.
#
# This is useful for changing the default initial configuration of newly created jobs.
Expand All @@ -33,7 +33,7 @@ def created(item)

# Called after a new job is created by copying from an existing job.
#
# For backward compatibility, the default implementation of this method calls@link #onCreated(Item)end.
# For backward compatibility, the default implementation of this method calls onCreated.
# If you choose to handle this method, think about whether you want to call super.onCopied or not.
#
# @param src_item
Expand All @@ -43,7 +43,7 @@ def created(item)
def copied(src_item, item)
end

# Called after all the jobs are loaded from disk into@link jenkins.model.Jenkinsend
# Called after all the jobs are loaded from disk into jenkins.model.Jenkins
# object.
def loaded()
end
Expand All @@ -61,7 +61,7 @@ def deleted(item)
# @param oldName
# The old name of the job.
# @param newName
# The new name of the job. Same as@link Item#getName()end.
# The new name of the job. Same as Item#getName().
def renamed(item, oldName, newName)
end

Expand Down
8 changes: 4 additions & 4 deletions ruby-runtime/lib/jenkins/listeners/item_listener_proxy.rb
Expand Up @@ -6,7 +6,7 @@ def initialize(plugin, object)
super(plugin, object)
end

# Called after a new job is created and added to@link jenkins.model.Jenkinsend,
# Called after a new job is created and added to jenkins.model.Jenkins,
# before the initial configuration page is provided.
#
# This is useful for changing the default initial configuration of newly created jobs.
Expand All @@ -17,7 +17,7 @@ def onCreated(item)

# Called after a new job is created by copying from an existing job.
#
# For backward compatibility, the default implementation of this method calls@link #onCreated(Item)end.
# For backward compatibility, the default implementation of this method calls onCreated.
# If you choose to handle this method, think about whether you want to call super.onCopied or not.
#
# @param src_item
Expand All @@ -28,7 +28,7 @@ def onCopied(src_item, item)
@object.copied(src_item, item);
end

# Called after all the jobs are loaded from disk into@link jenkins.model.Jenkinsend
# Called after all the jobs are loaded from disk into jenkins.model.Jenkins
# object.
def onLoaded()
@object.loaded
Expand All @@ -48,7 +48,7 @@ def onDeleted(item)
# @param oldName
# The old name of the job.
# @param newName
# The new name of the job. Same as@link Item#getName()end.
# The new name of the job. Same as Item#getName().
def onRenamed(item, oldName, newName)
@object.renamed(item, oldName, newName)
end
Expand Down
Expand Up @@ -17,7 +17,7 @@
class <%= name.capitalize %>Listener
include Jenkins::Listeners::ItemListener

# Called after a new job is created and added to@link jenkins.model.Jenkinsend,
# Called after a new job is created and added to jenkins.model.Jenkins,
# before the initial configuration page is provided.
#
# This is useful for changing the default initial configuration of newly created jobs.
Expand All @@ -27,15 +27,15 @@ class <%= name.capitalize %>Listener

# Called after a new job is created by copying from an existing job.
#
# For backward compatibility, the default implementation of this method calls@link #onCreated(Item)end.
# For backward compatibility, the default implementation of this method calls onCreated.
# If you choose to handle this method, think about whether you want to call super.onCopied or not.
#
# @param [Jenkins::Model::Item] The source item that the new one was copied from. Never null.
# @param [Jenkins::Model::Item] The newly created item. Never null.
def copied(src_item, item)
end

# Called after all the jobs are loaded from disk into@link jenkins.model.Jenkinsend
# Called after all the jobs are loaded from disk into jenkins.model.Jenkins
# object.
def loaded()
end
Expand All @@ -51,7 +51,7 @@ class <%= name.capitalize %>Listener
#
# @param [Jenkins::Model::Item] The item being renamed
# @param The old name of the job.
# @param The new name of the job. Same as@link Item#getName()end.
# @param The new name of the job. Same as Item#getName().
def renamed(item, oldName, newName)
end

Expand Down

0 comments on commit b7afcaf

Please sign in to comment.