Skip to content

Commit

Permalink
Added an rdoc task.
Browse files Browse the repository at this point in the history
Small RDoc improvements.
  • Loading branch information
mvidner committed Aug 30, 2009
1 parent 2b6b608 commit e091e48
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 4 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
/doc/rdoc
/pkg
*~
8 changes: 8 additions & 0 deletions Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ require 'rake'
require 'rake/gempackagetask'
require 'fileutils'
include FileUtils
require 'rake/rdoctask'

spec = Gem::Specification.new do |s|
s.name = "ruby-dbus"
Expand Down Expand Up @@ -29,3 +30,10 @@ task :gemspec do
f.write spec.to_ruby
end
end

Rake::RDocTask.new do |rd|
rd.rdoc_dir = 'doc/rdoc'
rd.rdoc_files.include("README", "lib/**/*.rb")
# rd.options << "--diagram"
# rd.options << "--all"
end
6 changes: 3 additions & 3 deletions lib/dbus/bus.rb
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
#
# Module containing all the D-Bus modules and classes.
module DBus
# This represents a remote service. It should not be instancied directly
# This represents a remote service. It should not be instantiated directly
# Use Bus::service()
class Service
# The service name.
Expand Down Expand Up @@ -48,7 +48,7 @@ def introspect
self
end

# Retrieves an object at the given _path_.
# Retrieves an object (ProxyObject) at the given _path_.
def object(path)
node = get_node(path, true)
if node.object.nil?
Expand Down Expand Up @@ -543,7 +543,7 @@ def process(m)
end
end

# Retrieves the service with the given _name_.
# Retrieves the Service with the given _name_.
def service(name)
# The service might not exist at this time so we cannot really check
# anything
Expand Down
2 changes: 1 addition & 1 deletion lib/dbus/introspect.rb
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,7 @@ def check_for_quoted_eval(s)
raise RuntimeException, "invalid internal data" if not s.to_s =~ /^[^"]+$/
end

# Defines a method on the interface from the descriptor _m_.
# Defines a method on the interface from the Method descriptor _m_.
def define_method_from_descriptor(m)
check_for_eval(m.name)
check_for_quoted_eval(@name)
Expand Down

0 comments on commit e091e48

Please sign in to comment.