*** empty log message ***
[m17n/m17n-docs.git] / utils / usr_filter.rb
index b09f7fb..10d4094 100755 (executable)
@@ -23,24 +23,37 @@ while gets
   gsub!(/\$[A-Z_]+/) {|m| m.delete!("$").reverse.downcase!.concat(" b@").reverse}
 
    case  $_
-     when /^$/
+     when /^\s*$/
        if doxy == 1 
            buf.push($_)
           end
-     when /\/\/\/\// 
+     when /\/\*=\*\// 
        commentblock(buf)
        buf = []
    
-     when /\/\*\s.*\*\//       # /* comment */ type comment
+     when /^\/\*\s.*\*\//      # /* comment */ type comment
        if doxy == 1            
-       buf.push($_.gsub!(/\*\//, " ").gsub!(/\/\*/, "//")) # should be included only in the example code
+         # should be included only in the example code
+         ## We used to do the following substituion as a workaround of
+         ## a Doxygen bug.
+         ## buf.push($_.gsub!(/\*\//, " ").gsub!(/\/\*/, "//"))
+         buf.push($_)
+       end
+
+     when /\/\*\s.*\*\//       # code + /* comment */ type comment
+       if doxy == 1            
+         # should be included in the example code
+         ## See the above comment.
+         ## buf.push($_.gsub!(/\*\//, " ").gsub!(/\/\*/, "//"))
+         buf.push($_) # should be included in the example code
        else
           if doxy == 0 
-         commentblock(buf)
-         buf = []
-         print $_.gsub!(/\/\*\s.*\*\//," ")                # should be omiited in code
+           commentblock(buf)
+           buf = []
+           print $_.gsub!(/\/\*\s.*\*\//," ") # should be omiited in code
          end
        end
+
      when /\/\*{2,3}ja.*\*\//  #japanese one liner
      when /\/\*\*en.*\*\//     #one liner
      when /\/\*\*\*en.*\*\//   #one liner
@@ -49,7 +62,7 @@ while gets
      when /\/\*\*\*\s.*\*\//   #one liner
         buf.push($_.gsub!(/\/\*+/, " ").gsub!(/\*\//, " ")).push("\n")
 
-     when /\/\*{1,2}\s|\/\*{2,3}ja|\/\*\*en/
+     when /\/\*{1,2}\s|\/\*{2,3}ja|\/\*\*en/  #this is not for En nor users
        doxy = -1
      when /\/\*\*\*en/
         buf.push($_.gsub!(/\/\*+en/, " "))
@@ -59,7 +72,7 @@ while gets
        doxy = 1
 
      when /EXAMPLE_CODE/ 
-        buf.push($_.gsub!(/#if EXAMPLE_CODE/, "@code \n"))
+        buf.push($_.gsub!(/#if EXAMPLE_CODE/, "\n \n @par Example:\n @code"))
        doxy = 1
 
      when /#endif/
@@ -88,3 +101,5 @@ while gets
         end
    end
 end
+
+commentblock(buf)