defunkt / tomdoc

A TomDoc Ruby library.
http://tomdoc.org/
MIT License
114 stars 16 forks source link

Doesn't document class methods #14

Closed metamn closed 13 years ago

metamn commented 13 years ago

Hello,

when running tomdoc generates only the class documentation without the methods.

Example:

require './page'
require './post'

# Generate artist portfolio from Dropbox using Jekyll
#
# Usage: folio url
#   url - the destination url where the portfolio will be generated
#
# Examples
#
#   folio inu.ro 
#   #=> /inu.ro will contain the Jekyll site generated
#
# Returns a Jekyll site
class Folio

  include Utils

  attr_reader :dir, :config, :dropbox

  # Initialize Folio
  #
  # args - the command line arguments
  #
  # Sets the following variables:
  # dir - the output directory
  # config - configuration loaded from 'config.yml'
  #
  # Page is initialized here and used later in generating pages and menu
  def initialize(args)
    raise ArgumentError, usage if args.empty? 
    @dir = args[0]
    puts "Output directory: #{@dir}"

    load_config

    @page = Page.new("#{@dir}", @config['page_extension']) 
  end
...
end

Output:

cs@d820:~/work/folio$ tomdoc folio.rb 
--------------------------------------------------------------------------------
Folio

Generate artist portfolio from Dropbox using Jekyll

Usage: folio url
  url - the destination url where the portfolio will be generated

Examples

  folio inu.ro 
  #=> /inu.ro will contain the Jekyll site generated

Returns a Jekyll site
metamn commented 13 years ago

Ok, I've got it.

the syntax must be perfect, ie. "Returns ..." must be present all the time