Home → Problems →

metasm doc

• Edit

peng

29 Jul, 2012 04:04 PM

There are no files recognized execept the readme? What's the reason and how can I change that?

1. 1 Posted by peng on 29 Jul, 2012 04:46 PM

   

   Alright my fault. I forked it and altered it to obey ruby naming conventions. Now it works.

   • Edit

2. 2 Posted by peng on 29 Jul, 2012 05:05 PM

   

   But there is another issue why is there no documentation generated for shown for the attributes declared with attr_accessor. See here: https://gist.github.com/3200260
   Specifically there are docs generated but these are standard phrases with no meaning while there are specific comments in the source code.

   • Edit

3. Support Staff 3 Posted by lsegal on 29 Jul, 2012 05:13 PM

   

   YARD doesn't support that syntax. You either want your comments above the multi-attr attr_accessor definition, or you want multiple attr_accessor fields with their own documentation-- preferably the latter.

   You can try this all by running yard locally before you push to github or release a gem to ensure that your docs are properly formatted.

   • Edit

4. lsegal closed this discussion on 29 Jul, 2012 05:13 PM.