Unverified Commit ced710fc authored by Viktor Söderqvist's avatar Viktor Söderqvist Committed by GitHub
Browse files

Module API doc script: Mark unreleased API functions (#10674)



* Module API doc script: Mark unreleased API functions

* fix broken quotes in generate-module-api-doc.rb
Co-authored-by: default avatarOran Agra <oran@redislabs.com>
parent f44c3432
#!/usr/bin/env ruby #!/usr/bin/env ruby
# coding: utf-8 # coding: utf-8
# gendoc.rb -- Converts the top-comments inside module.c to modules API # gendoc.rb -- Converts the top-comments inside module.c to modules API
# reference documentation in markdown format. # reference documentation in markdown format.
...@@ -80,7 +79,7 @@ def docufy(src,i) ...@@ -80,7 +79,7 @@ def docufy(src,i)
puts "<span id=\"#{name}\"></span>\n\n" puts "<span id=\"#{name}\"></span>\n\n"
puts "### `#{name}`\n\n" puts "### `#{name}`\n\n"
puts " #{proto}\n" puts " #{proto}\n"
puts "**Available since:** #{$since[name]}\n\n" if $since[name] puts "**Available since:** #{$since[name] or "unreleased"}\n\n"
comment = "" comment = ""
while true while true
i = i-1 i = i-1
...@@ -138,8 +137,8 @@ def is_func_line(src, i) ...@@ -138,8 +137,8 @@ def is_func_line(src, i)
end end
puts "---\n" puts "---\n"
puts "title: "Modules API reference"\n" puts "title: \"Modules API reference\"\n"
puts "linkTitle: "API reference"\n" puts "linkTitle: \"API reference\"\n"
puts "weight: 1\n" puts "weight: 1\n"
puts "description: >\n" puts "description: >\n"
puts " Reference for the Redis Modules API\n" puts " Reference for the Redis Modules API\n"
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment