ruby - How to get Yardoc to output to STDOUT? -


i've looked templates come gem (i can find default html outputter), i've searched , online docs switch redirect stdout. can't find on how might approach this.

is there easy way (perhaps shell command?) or have wade through source code?

  • create following file test.rb:

    # class cool class test   # method cool   def foo   end end

  • you must compile yard documentation before can output this. don't want doc folder right? let's omit that.

    yardoc --no-output test.rb

    this update documentation inside .yardoc folder hidden. doc folder not generated.

  • now can see documentation specific objects in few ways:

    > yard display "test" # outputs: ------------------------------------------ class: foo < object      class cool    --------------------------------------------------------------  > yard display "test#foo" # outputs: ------------------------------------------ method: #meth (foo)                                           (defined in: foo.rb)      foo.meth -> object --------------------------------------------------------------      method cool

    this output get. can yard documentation class/method using yard display command.

  • but hey, output sucks! let's create template it. create following templates folder few files:

    + app   + templates     + default       + class       | + text       |   + setup.rb       |       def init       |         super       |         sections t('docstring')       |       end       + method       | + text       |   + setup.rb       |       def init       |         super       |         sections t('docstring')       |       end       + method_details       | + text       |   + setup.rb       |       def init       |         super       |         sections t('docstring')       |       end

    all setup.rb files must have same content def init, super, sections t('docstring'), end. make text output display documentation, without fancy headers , stuff.

  • now run same yard display command, let's use our custom templates:

    > yard display foo --template-path ./templates  class cool  > yard display "foo#meth" --template-path ./templates  method cool

  • that's it. may find yard doc may have of leading/trailing new lines in output, can use other standard linux head/tail commands fix that.


Comments

Post a Comment

Popular posts from this blog

.htaccess - First slash is removed after domain when entering a webpage in the browser -

sometimes when hit address of webpage in browser, removes first slash after domain. examples: www.mywebsite.com/scripts/script_6.php -> trying load www.mywebsite.comscripts/script_6.php www.mywebsite.com/test.php -> trying load www.mywebsite.comtest.php after entering again, loads page. a .htaccess settings must wrong: rewritebase / errordocument 404 http://www.mywebsite.com/oops.php errordocument 401 /notallowed.php rewriteengine on # turn on rewriting engine #gzip <ifmodule mod_deflate.c> addoutputfilterbytype deflate text/text text/html text/plain text/xml text/css application/x- javascript application/javascript </ifmodule> #end gzip rewritecond %{http_host} ^mywebsite\.com rewriterule ^(.*)$ http://www.mywebsite.com$1 [r=permanent,l] directoryindex index6.php rewriterule ^termsofuse/?$ termsofuse.php [nc,l] # handle requests "adpolicy" rewriterule ^privacy-policy/?$ privacy-policy.php [nc,l] # handle requ...
Read more

Socket.connect doesn't throw exception in Android -

if put nonsense url no exception thrown , none of rest of code executed not rest of asynctask called method connects. try { socketcliente.connect(new inetsocketaddress("f", port), 2000); } catch (unknownhostexception e) { geterror("host doesn't exist"); return -1; } catch (ioexception e) { geterror("could not connect: host down"); return -1; } add catch statement. catch ( exception e ) { log.d(tag, e.getmessage(),e); toast.maketext(getapplicationcontext(), "unexpected error:" + e.getmessage(), toast.length_long).show(); } this write log , pop toast tell what's going on.
Read more

SPSS keyboard combination alters encoding -

my question not have programming practical issue on spss. accident keyword combination cannot remember because did not intend press changed encoding in spss , text in data in different language english shown small boxes. nevertheless, when kind of analysis performed different language text shown in output. does know reason? tried change encoding did not produce result. first, @ edit > options , see whether setting unicode or locale. might fix it. if have text in multiple languages, want unicode. otherwise, may have specific locale set wrong. can change set locale, need know locale want use.
Read more