Hi all,
Just wondering why the content in <railsapp>/lib/ is not included
when doing a >$ rake appdoc ??
I added this to the rakefile [ rdoc.rdoc_files.include(''lib/**/
*.rb'') ] which works sort of, although protected methods in the files
don''t show up.
I''m a newbie trying to understand the SaltedLoginGenerator code.
Kind regards,
Mats
----
"TextMate, coding with an incredible sense of joy and ease"
- www.macromates.com -
Jarkko Laine
2005-Aug-18 15:57 UTC
Re: Why is <railsapp>/lib/ not included in rake appdoc ?
Hi Mats, On 18.8.2005, at 18.41, Mats Persson wrote:> > Just wondering why the content in <railsapp>/lib/ is not included > when doing a >$ rake appdoc ??Sorry, dunno about this.> > I added this to the rakefile [ rdoc.rdoc_files.include(''lib/**/ > *.rb'') ] which works sort of, although protected methods in the > files don''t show up.RDoc doesn''t document protected and private methods by default. If you want a particular method documented, you can use a documentation modifier for it, like this: # Some docs def myproc # :doc: # code end The :doc: modifier forces the method to be documented even if it wouldn''t be otherwise. //jarkko> > I''m a newbie trying to understand the SaltedLoginGenerator code. > > > Kind regards, > > Mats > > ---- > "TextMate, coding with an incredible sense of joy and ease" > - www.macromates.com - > > > _______________________________________________ > Rails mailing list > Rails-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org > http://lists.rubyonrails.org/mailman/listinfo/rails >_______________________________________________ Rails mailing list Rails-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org http://lists.rubyonrails.org/mailman/listinfo/rails
You can add --all to the options list in the appdoc task to show all methods: rdoc.options << "--all" Ken On 8/18/05, Jarkko Laine <jarkko-k1O+Gnc6WpmsTnJN9+BGXg@public.gmane.org> wrote:> > Hi Mats, > > On 18.8.2005, at 18.41, Mats Persson wrote: > > > > Just wondering why the content in <railsapp>/lib/ is not included > > when doing a >$ rake appdoc ?? > > Sorry, dunno about this. > > > > > I added this to the rakefile [ rdoc.rdoc_files.include(''lib/**/ > > *.rb'') ] which works sort of, although protected methods in the > > files don''t show up. > > RDoc doesn''t document protected and private methods by default. If > you want a particular method documented, you can use a documentation > modifier for it, like this: > > # Some docs > def myproc # :doc: > # code > end > > The :doc: modifier forces the method to be documented even if it > wouldn''t be otherwise. > > //jarkko > > > > > > I''m a newbie trying to understand the SaltedLoginGenerator code. > > > > > > Kind regards, > > > > Mats > > > > ---- > > "TextMate, coding with an incredible sense of joy and ease" > > - www.macromates.com <http://www.macromates.com> - > > > > > > _______________________________________________ > > Rails mailing list > > Rails-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org > > http://lists.rubyonrails.org/mailman/listinfo/rails > > > > > > _______________________________________________ > Rails mailing list > Rails-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org > http://lists.rubyonrails.org/mailman/listinfo/rails > > > >_______________________________________________ Rails mailing list Rails-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org http://lists.rubyonrails.org/mailman/listinfo/rails