vendor/gems/BlueCloth-1.0.0/utils.rb
### Given a documentation <tt>catalogFile</tt>, which is in the same format
### as that described by #readManifest, read and expand it, and then return
### a list of those files which appear to have RDoc documentation in
### them. If <tt>catalogFile</tt> is nil or does not exist, the MANIFEST
### file is used instead.
Given a documentation catalogFile, which is in the same format
as that described by #readManifest, read and expand it, and then return
a list of those files which appear to have RDoc documentation in
them. If catalogFile is nil or does not exist, the MANIFEST
file is used instead.
Given a documentation catalogFile which is in the same format as that described by #readManifest read and expand it and then return a list of those files which appear to have RDoc documentation in them . If catalogFile is nil or does not exist the MANIFEST file is used instead .
def findRdocableFiles( catalogFile="docs/CATALOG" )
		startlist = []
		if File.exists? catalogFile
			message "Using CATALOG file (%s).\n" % catalogFile
			startlist = getVettedManifest( catalogFile )
		else
			message "Using default MANIFEST\n"
			startlist = getVettedManifest()
		end
		message "Looking for RDoc comments in:\n" if $VERBOSE
		startlist.select {|fn|
			message "  #{fn}: " if $VERBOSE
			found = false
			File::open( fn, "r" ) {|fh|
				fh.each {|line|
					if line =~ /^(\s*#)?\s*=/ || line =~ /:\w+:/ || line =~ %r{/\*}
						found = true
						break
					end
				}
			}
			message( (found ? "yes" : "no") + "\n" ) if $VERBOSE
			found
		}
	end
def findRdocableFiles ( catalogFile = "docs/CATALOG" ) startlist = [ ] if File . exists? catalogFile message "Using CATALOG file (%s).\n" % catalogFile startlist = getVettedManifest ( catalogFile ) else message "Using default MANIFEST\n" startlist = getVettedManifest ( ) end message "Looking for RDoc comments in:\n" if $VERBOSE startlist . select { | fn | message "  #{fn}: " if $VERBOSE found = false File :: open ( fn , "r" ) { | fh | fh . each { | line | if line =~ / ^( \s *#)? \s *= / || line =~ / : \w +: / || line =~ %r{ / \* } found = true break end } } message ( ( found ? "yes" : "no" ) + "\n" ) if $VERBOSE found } end
Given a documentation <tt>catalogFile</tt>, which is in the same format
as that described by #readManifest, read and expand it, and then return
a list of those files which appear to have RDoc documentation in
them.
Given a documentation <tt > catalogFile< / tt > which is in the same format as that described by #readManifest read and expand it and then return a list of those files which appear to have RDoc documentation in them .
catalogFile
<not_specific>