Changeset 2003Tweet

Timestamp:

Nov 17, 2007, 3:15:01 AM (12 years ago)

Author:

Sam Hocevar

Message:

• Slightly doxygenated ruby/README so that it appears in the manual (see ​http://libcaca.zoy.org/manual/libcaca-ruby.html).

Location:

libcaca/trunk

Files:

• doc/doxygen.cfg.in (modified) (2 diffs)
• doc/libcaca.dox (modified) (1 diff)
• ruby/README (modified) (8 diffs)

libcaca/trunk/doc/doxygen.cfg.in

@@ -487 +487 @@
                          @top_srcdir@/doc \
                          @top_srcdir@/cucul \
-                         @top_srcdir@/caca
+                         @top_srcdir@/caca \
+                         @top_srcdir@/ruby
 
 # This tag can be used to specify the character encoding of the source files that 
@@ -507 +508 @@
                          cucul.h \
                          caca.h \
+                         AUTHORS \
                          NEWS \
-                         AUTHORS \
+                         README \
                          THANKS \
                          TODO

libcaca/trunk/doc/libcaca.dox

@@ -34 +34 @@
  - caca.h
 
+ There is language-specific documentation for the various bindings:
+
+ - \subpage libcaca-ruby
+
  Some other topics are covered by specific sections:
 

libcaca/trunk/ruby/README

@@ +1 @@
+/* $Id$ */ /** \page libcaca-ruby Libcaca ruby bindings
+
 This a Ruby binding for libcucul, libcaca will be added later.
 
@@ -19 +21 @@
 What is currently available is :
 
+\code
 $ irb -rcucul
 irb(main):001:0> Cucul.constants
@@ -25 +28 @@
 "UNDERLINE", "RED", "WHITE", "BLACK", "LIGHTCYAN", "LIGHTGRAY",
 "ITALICS", "CYAN", "YELLOW", "LIGHTGREEN", "Canvas", "Font"]
+\endcode
 
+\code
 irb(main):002:0> Cucul::Canvas.methods.sort -
 Cucul::Canvas.ancestors[1].methods
 => ["export_list", "import_list"]
+\endcode
 
+\code
 irb(main):003:0> Cucul::Canvas.instance_methods.sort -
 Cucul::Canvas.ancestors[1].instance_methods
@@ -45 +52 @@
 "set_frame_name", "set_handle", "set_height", "set_size", "set_width",
 "stretch_left", "stretch_right", "width", "width="]
+\endcode
 
 irb(main):004:0> Cucul::Font.methods.sort -
@@ -56 +64 @@
 And here are sample uses :
 
+\code
 $ ruby -rcucul -e 'c=Cucul::Canvas.new(6, 3).fill_box(0,0,2,2,"#"[0]);
 c2=Cucul::Canvas.new(1, 1).put_str(0,0,"x"); c.blit(1,1,c2); puts
@@ -62 +71 @@
 #x#   
 ###  
+\endcode
 
+\code
 $ ruby -e 'puts Cucul::Canvas.new(6,3).draw_thin_polyline([[0,0], [2,0],
 [5,2],[0,0]]).export_memory("irc")' 
@@ -68 +79 @@
 | `.  
 ----`-
+\endcode
 
+\code
 $ ruby -rcucul -e 'p Cucul::Canvas.export_list'
 [["caca", "native libcaca format"], ["ansi", "ANSI"], ["utf8", "UTF-8
@@ -75 +88 @@
 ["irc", "IRC with mIRC colours"], ["ps", "PostScript document"], ["svg",
 "SVG vector image"], ["tga", "TGA image"]]
+\endcode
 
+\code
 $ ruby -rcucul -e 'p Cucul::Font.list'
 ["Monospace 9", "Monospace Bold 12"]
+\endcode
+
+*/