From e105d50d66a06c8077379782e8293b40338b5293 Mon Sep 17 00:00:00 2001 From: Robin Gareus Date: Tue, 22 Mar 2016 00:50:14 +0100 Subject: [PATCH] update luadoc --- doc/luadoc.json | 382 +++++++++++++++++++++---------------------- tools/fmt-luadoc.php | 20 ++- 2 files changed, 204 insertions(+), 198 deletions(-) diff --git a/doc/luadoc.json b/doc/luadoc.json index b3c4236020..d14fdb3bae 100644 --- a/doc/luadoc.json +++ b/doc/luadoc.json @@ -1,5 +1,5 @@ [ -{"version" : "4.7-421-g7083d71"}, +{"version" : "4.7-430-g307f0b4"}, {"type" : "[C] Class", "lua" : "C:StringList", @@ -269,14 +269,124 @@ "decl" : "PBD::Controllable::GroupControlDisposition" }, {"type" : "[C] Class", - "lua" : "ARDOUR:BBT_TIME", + "lua" : "Timecode:BBT_TIME", "decl" : "Timecode::BBT_Time" }, {"type" : "Constructor", - "lua" : "ARDOUR:BBT_TIME:", + "lua" : "Timecode:BBT_TIME:", "ret" : "void", "decl" : "void (*)(unsigned int, unsigned int, unsigned int)" }, +{"type" : "[C] Class", + "lua" : "Evoral:Parameter", + "decl" : "Evoral::Parameter" +}, +{"type" : "Constructor", + "lua" : "Evoral:Parameter:", + "ret" : "void", + "decl" : "void (*)(unsigned int, unsigned char, unsigned int)" +}, +{"type" : "Member Function", + "lua" : "Evoral:Parameter:type", + "ret" : "unsigned int", + "decl" : "unsigned int (Evoral::Parameter::*)()" +}, +{"type" : "Member Function", + "lua" : "Evoral:Parameter:channel", + "ret" : "unsigned char", + "decl" : "unsigned char (Evoral::Parameter::*)()" +}, +{"type" : "Member Function", + "lua" : "Evoral:Parameter:id", + "ret" : "unsigned int", + "decl" : "unsigned int (Evoral::Parameter::*)()" +}, +{"type" : "[C] Class", + "lua" : "Evoral:ControlList", + "decl" : "boost::weak_ptr" +}, +{"type" : "[C] Class", + "lua" : "Evoral:ControlList", + "decl" : "boost::shared_ptr" +}, +{"type" : "[C] Weak/Shared Pointer Class", + "lua" : "Evoral:ControlList", + "decl" : "Evoral::ControlList" +}, +{"type" : "Weak/Shared Null Check", + "lua" : "Evoral:ControlList:isnil", + "ret" : "bool", + "decl" : "void (*)()" +}, +{"type" : "Weak/Shared Pointer Function", + "lua" : "Evoral:ControlList:add", + "ret" : "void", + "decl" : "void (Evoral::ControlList::*)(double, double, bool, bool)" +}, +{"type" : "[C] Class", + "lua" : "Evoral:ControlSet", + "decl" : "boost::weak_ptr" +}, +{"type" : "[C] Class", + "lua" : "Evoral:ControlSet", + "decl" : "boost::shared_ptr" +}, +{"type" : "[C] Weak/Shared Pointer Class", + "lua" : "Evoral:ControlSet", + "decl" : "Evoral::ControlSet" +}, +{"type" : "Weak/Shared Null Check", + "lua" : "Evoral:ControlSet:isnil", + "ret" : "bool", + "decl" : "void (*)()" +}, +{"type" : "[C] Class", + "lua" : "Evoral:Control", + "decl" : "boost::weak_ptr" +}, +{"type" : "[C] Class", + "lua" : "Evoral:Control", + "decl" : "boost::shared_ptr" +}, +{"type" : "[C] Weak/Shared Pointer Class", + "lua" : "Evoral:Control", + "decl" : "Evoral::Control" +}, +{"type" : "Weak/Shared Null Check", + "lua" : "Evoral:Control:isnil", + "ret" : "bool", + "decl" : "void (*)()" +}, +{"type" : "Weak/Shared Pointer Function", + "lua" : "Evoral:Control:list", + "ret" : "boost::shared_ptr", + "decl" : "boost::shared_ptr (Evoral::Control::*)()" +}, +{"type" : "[C] Class", + "lua" : "Evoral:ParameterDescriptor", + "decl" : "Evoral::ParameterDescriptor" +}, +{"type" : "Constructor", + "lua" : "Evoral:ParameterDescriptor:", + "ret" : "void", + "decl" : "void (*)()" +}, +{"type" : "Data Member", + "lua" : "Evoral:ParameterDescriptor:lower", + "decl" : "float Evoral::ParameterDescriptor::*" +}, +{"type" : "Data Member", + "lua" : "Evoral:ParameterDescriptor:upper", + "decl" : "float Evoral::ParameterDescriptor::*" +}, +{"type" : "Data Member", + "lua" : "Evoral:ParameterDescriptor:normal", + "decl" : "float Evoral::ParameterDescriptor::*" +}, +{"type" : "Data Member", + "lua" : "Evoral:ParameterDescriptor:toggled", + "decl" : "bool Evoral::ParameterDescriptor::*" +}, {"type" : "[C] Class", "lua" : "ARDOUR:PluginInfo", "decl" : "boost::weak_ptr" @@ -887,30 +997,6 @@ "ret" : "bool", "decl" : "void (*)()" }, -{"type" : "[C] Class", - "lua" : "ARDOUR:EvoralParameter", - "decl" : "Evoral::Parameter" -}, -{"type" : "Constructor", - "lua" : "ARDOUR:EvoralParameter:", - "ret" : "void", - "decl" : "void (*)(unsigned int, unsigned char, unsigned int)" -}, -{"type" : "Member Function", - "lua" : "ARDOUR:EvoralParameter:type", - "ret" : "unsigned int", - "decl" : "unsigned int (Evoral::Parameter::*)()" -}, -{"type" : "Member Function", - "lua" : "ARDOUR:EvoralParameter:channel", - "ret" : "unsigned char", - "decl" : "unsigned char (Evoral::Parameter::*)()" -}, -{"type" : "Member Function", - "lua" : "ARDOUR:EvoralParameter:id", - "ret" : "unsigned int", - "decl" : "unsigned int (Evoral::Parameter::*)()" -}, {"type" : "[C] Class", "lua" : "ARDOUR:PresetRecord", "decl" : "ARDOUR::Plugin::PresetRecord" @@ -931,45 +1017,6 @@ "lua" : "ARDOUR:PresetRecord:valid", "decl" : "bool ARDOUR::Plugin::PresetRecord::*" }, -{"type" : "[C] Class", - "lua" : "ARDOUR:EvoralControlList", - "decl" : "boost::weak_ptr" -}, -{"type" : "[C] Class", - "lua" : "ARDOUR:EvoralControlList", - "decl" : "boost::shared_ptr" -}, -{"type" : "[C] Weak/Shared Pointer Class", - "lua" : "ARDOUR:EvoralControlList", - "decl" : "Evoral::ControlList" -}, -{"type" : "Weak/Shared Null Check", - "lua" : "ARDOUR:EvoralControlList:isnil", - "ret" : "bool", - "decl" : "void (*)()" -}, -{"type" : "Weak/Shared Pointer Function", - "lua" : "ARDOUR:EvoralControlList:add", - "ret" : "void", - "decl" : "void (Evoral::ControlList::*)(double, double, bool, bool)" -}, -{"type" : "[C] Class", - "lua" : "ARDOUR:EvoralControlSet", - "decl" : "boost::weak_ptr" -}, -{"type" : "[C] Class", - "lua" : "ARDOUR:EvoralControlSet", - "decl" : "boost::shared_ptr" -}, -{"type" : "[C] Weak/Shared Pointer Class", - "lua" : "ARDOUR:EvoralControlSet", - "decl" : "Evoral::ControlSet" -}, -{"type" : "Weak/Shared Null Check", - "lua" : "ARDOUR:EvoralControlSet:isnil", - "ret" : "bool", - "decl" : "void (*)()" -}, {"type" : "[C] Derived Class", "lua" : "ARDOUR:Automatable", "decl" : "boost::shared_ptr", @@ -995,53 +1042,6 @@ "ret" : "boost::shared_ptr", "decl" : "boost::shared_ptr (ARDOUR::Automatable::*)(Evoral::Parameter, bool)" }, -{"type" : "[C] Class", - "lua" : "ARDOUR:EvoralControl", - "decl" : "boost::weak_ptr" -}, -{"type" : "[C] Class", - "lua" : "ARDOUR:EvoralControl", - "decl" : "boost::shared_ptr" -}, -{"type" : "[C] Weak/Shared Pointer Class", - "lua" : "ARDOUR:EvoralControl", - "decl" : "Evoral::Control" -}, -{"type" : "Weak/Shared Null Check", - "lua" : "ARDOUR:EvoralControl:isnil", - "ret" : "bool", - "decl" : "void (*)()" -}, -{"type" : "Weak/Shared Pointer Function", - "lua" : "ARDOUR:EvoralControl:list", - "ret" : "boost::shared_ptr", - "decl" : "boost::shared_ptr (Evoral::Control::*)()" -}, -{"type" : "[C] Class", - "lua" : "ARDOUR:EvoralParameterDescriptor", - "decl" : "Evoral::ParameterDescriptor" -}, -{"type" : "Constructor", - "lua" : "ARDOUR:EvoralParameterDescriptor:", - "ret" : "void", - "decl" : "void (*)()" -}, -{"type" : "Data Member", - "lua" : "ARDOUR:EvoralParameterDescriptor:lower", - "decl" : "float Evoral::ParameterDescriptor::*" -}, -{"type" : "Data Member", - "lua" : "ARDOUR:EvoralParameterDescriptor:upper", - "decl" : "float Evoral::ParameterDescriptor::*" -}, -{"type" : "Data Member", - "lua" : "ARDOUR:EvoralParameterDescriptor:normal", - "decl" : "float Evoral::ParameterDescriptor::*" -}, -{"type" : "Data Member", - "lua" : "ARDOUR:EvoralParameterDescriptor:toggled", - "decl" : "bool Evoral::ParameterDescriptor::*" -}, {"type" : "[C] Derived Class", "lua" : "ARDOUR:ParameterDescriptor", "decl" : "ARDOUR::ParameterDescriptor", @@ -2820,389 +2820,389 @@ "decl" : "int (*)(lua_State*)" }, {"type" : "[C] Class", - "lua" : "ARDOUR:RegionSelection", + "lua" : "ArdourUI:RegionSelection", "decl" : "RegionSelection" }, {"type" : "Member Function", - "lua" : "ARDOUR:RegionSelection:clear_all", + "lua" : "ArdourUI:RegionSelection:clear_all", "ret" : "void", "decl" : "void (RegionSelection::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:RegionSelection:start", + "lua" : "ArdourUI:RegionSelection:start", "ret" : "long", "decl" : "long (RegionSelection::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:RegionSelection:end_frame", + "lua" : "ArdourUI:RegionSelection:end_frame", "ret" : "long", "decl" : "long (RegionSelection::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:RegionSelection:n_midi_regions", + "lua" : "ArdourUI:RegionSelection:n_midi_regions", "ret" : "unsigned long", "decl" : "unsigned long (RegionSelection::*)()" }, {"type" : "[C] Class", - "lua" : "ARDOUR:ArdourMarker", + "lua" : "ArdourUI:ArdourMarker", "decl" : "ArdourMarker" }, {"type" : "[C] Class", - "lua" : "ARDOUR:Editor", + "lua" : "ArdourUI:Editor", "decl" : "PublicEditor" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:snap_type", + "lua" : "ArdourUI:Editor:snap_type", "ret" : "Editing::SnapType", "decl" : "Editing::SnapType (PublicEditor::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:snap_mode", + "lua" : "ArdourUI:Editor:snap_mode", "ret" : "Editing::SnapMode", "decl" : "Editing::SnapMode (PublicEditor::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:set_snap_mode", + "lua" : "ArdourUI:Editor:set_snap_mode", "ret" : "void", "decl" : "void (PublicEditor::*)(Editing::SnapMode)" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:set_snap_threshold", + "lua" : "ArdourUI:Editor:set_snap_threshold", "ret" : "void", "decl" : "void (PublicEditor::*)(double)" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:undo", + "lua" : "ArdourUI:Editor:undo", "ret" : "void", "decl" : "void (PublicEditor::*)(unsigned int)" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:redo", + "lua" : "ArdourUI:Editor:redo", "ret" : "void", "decl" : "void (PublicEditor::*)(unsigned int)" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:set_mouse_mode", + "lua" : "ArdourUI:Editor:set_mouse_mode", "ret" : "void", "decl" : "void (PublicEditor::*)(Editing::MouseMode, bool)" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:current_mouse_mode", + "lua" : "ArdourUI:Editor:current_mouse_mode", "ret" : "Editing::MouseMode", "decl" : "Editing::MouseMode (PublicEditor::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:consider_auditioning", + "lua" : "ArdourUI:Editor:consider_auditioning", "ret" : "void", "decl" : "void (PublicEditor::*)(boost::shared_ptr)" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:new_region_from_selection", + "lua" : "ArdourUI:Editor:new_region_from_selection", "ret" : "void", "decl" : "void (PublicEditor::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:separate_region_from_selection", + "lua" : "ArdourUI:Editor:separate_region_from_selection", "ret" : "void", "decl" : "void (PublicEditor::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:pixel_to_sample", + "lua" : "ArdourUI:Editor:pixel_to_sample", "ret" : "long", "decl" : "long (PublicEditor::*)(double)" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:sample_to_pixel", + "lua" : "ArdourUI:Editor:sample_to_pixel", "ret" : "double", "decl" : "double (PublicEditor::*)(long)" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:play_selection", + "lua" : "ArdourUI:Editor:play_selection", "ret" : "void", "decl" : "void (PublicEditor::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:play_with_preroll", + "lua" : "ArdourUI:Editor:play_with_preroll", "ret" : "void", "decl" : "void (PublicEditor::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:maybe_locate_with_edit_preroll", + "lua" : "ArdourUI:Editor:maybe_locate_with_edit_preroll", "ret" : "void", "decl" : "void (PublicEditor::*)(long)" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:goto_nth_marker", + "lua" : "ArdourUI:Editor:goto_nth_marker", "ret" : "void", "decl" : "void (PublicEditor::*)(int)" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:add_location_from_playhead_cursor", + "lua" : "ArdourUI:Editor:add_location_from_playhead_cursor", "ret" : "void", "decl" : "void (PublicEditor::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:remove_location_at_playhead_cursor", + "lua" : "ArdourUI:Editor:remove_location_at_playhead_cursor", "ret" : "void", "decl" : "void (PublicEditor::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:set_show_measures", + "lua" : "ArdourUI:Editor:set_show_measures", "ret" : "void", "decl" : "void (PublicEditor::*)(bool)" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:show_measures", + "lua" : "ArdourUI:Editor:show_measures", "ret" : "bool", "decl" : "bool (PublicEditor::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:remove_tracks", + "lua" : "ArdourUI:Editor:remove_tracks", "ret" : "void", "decl" : "void (PublicEditor::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:effective_mouse_mode", + "lua" : "ArdourUI:Editor:effective_mouse_mode", "ret" : "Editing::MouseMode", "decl" : "Editing::MouseMode (PublicEditor::*)()" }, {"type" : "Member Function RefReturn", - "lua" : "ARDOUR:Editor:do_import", + "lua" : "ArdourUI:Editor:do_import", "ret" : "void", "decl" : "void (PublicEditor::*)(std::vector, Editing::ImportDisposition, Editing::ImportMode, ARDOUR::SrcQuality, long&, boost::shared_ptr)" }, {"type" : "Member Function RefReturn", - "lua" : "ARDOUR:Editor:do_embed", + "lua" : "ArdourUI:Editor:do_embed", "ret" : "void", "decl" : "void (PublicEditor::*)(std::vector, Editing::ImportDisposition, Editing::ImportMode, long&, boost::shared_ptr)" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:export_audio", + "lua" : "ArdourUI:Editor:export_audio", "ret" : "void", "decl" : "void (PublicEditor::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:stem_export", + "lua" : "ArdourUI:Editor:stem_export", "ret" : "void", "decl" : "void (PublicEditor::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:export_selection", + "lua" : "ArdourUI:Editor:export_selection", "ret" : "void", "decl" : "void (PublicEditor::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:export_range", + "lua" : "ArdourUI:Editor:export_range", "ret" : "void", "decl" : "void (PublicEditor::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:set_zoom_focus", + "lua" : "ArdourUI:Editor:set_zoom_focus", "ret" : "void", "decl" : "void (PublicEditor::*)(Editing::ZoomFocus)" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:get_zoom_focus", + "lua" : "ArdourUI:Editor:get_zoom_focus", "ret" : "Editing::ZoomFocus", "decl" : "Editing::ZoomFocus (PublicEditor::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:get_current_zoom", + "lua" : "ArdourUI:Editor:get_current_zoom", "ret" : "long", "decl" : "long (PublicEditor::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:reset_zoom", + "lua" : "ArdourUI:Editor:reset_zoom", "ret" : "void", "decl" : "void (PublicEditor::*)(long)" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:select_all_tracks", + "lua" : "ArdourUI:Editor:select_all_tracks", "ret" : "void", "decl" : "void (PublicEditor::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:deselect_all", + "lua" : "ArdourUI:Editor:deselect_all", "ret" : "void", "decl" : "void (PublicEditor::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:set_stationary_playhead", + "lua" : "ArdourUI:Editor:set_stationary_playhead", "ret" : "void", "decl" : "void (PublicEditor::*)(bool)" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:stationary_playhead", + "lua" : "ArdourUI:Editor:stationary_playhead", "ret" : "bool", "decl" : "bool (PublicEditor::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:set_follow_playhead", + "lua" : "ArdourUI:Editor:set_follow_playhead", "ret" : "void", "decl" : "void (PublicEditor::*)(bool, bool)" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:follow_playhead", + "lua" : "ArdourUI:Editor:follow_playhead", "ret" : "bool", "decl" : "bool (PublicEditor::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:dragging_playhead", + "lua" : "ArdourUI:Editor:dragging_playhead", "ret" : "bool", "decl" : "bool (PublicEditor::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:leftmost_sample", + "lua" : "ArdourUI:Editor:leftmost_sample", "ret" : "long", "decl" : "long (PublicEditor::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:current_page_samples", + "lua" : "ArdourUI:Editor:current_page_samples", "ret" : "long", "decl" : "long (PublicEditor::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:visible_canvas_height", + "lua" : "ArdourUI:Editor:visible_canvas_height", "ret" : "double", "decl" : "double (PublicEditor::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:temporal_zoom_step", + "lua" : "ArdourUI:Editor:temporal_zoom_step", "ret" : "void", "decl" : "void (PublicEditor::*)(bool)" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:override_visible_track_count", + "lua" : "ArdourUI:Editor:override_visible_track_count", "ret" : "void", "decl" : "void (PublicEditor::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:scroll_tracks_down_line", + "lua" : "ArdourUI:Editor:scroll_tracks_down_line", "ret" : "void", "decl" : "void (PublicEditor::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:scroll_tracks_up_line", + "lua" : "ArdourUI:Editor:scroll_tracks_up_line", "ret" : "void", "decl" : "void (PublicEditor::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:scroll_down_one_track", + "lua" : "ArdourUI:Editor:scroll_down_one_track", "ret" : "bool", "decl" : "bool (PublicEditor::*)(bool)" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:scroll_up_one_track", + "lua" : "ArdourUI:Editor:scroll_up_one_track", "ret" : "bool", "decl" : "bool (PublicEditor::*)(bool)" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:reset_x_origin", + "lua" : "ArdourUI:Editor:reset_x_origin", "ret" : "void", "decl" : "void (PublicEditor::*)(long)" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:get_y_origin", + "lua" : "ArdourUI:Editor:get_y_origin", "ret" : "double", "decl" : "double (PublicEditor::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:reset_y_origin", + "lua" : "ArdourUI:Editor:reset_y_origin", "ret" : "void", "decl" : "void (PublicEditor::*)(double)" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:remove_last_capture", + "lua" : "ArdourUI:Editor:remove_last_capture", "ret" : "void", "decl" : "void (PublicEditor::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:maximise_editing_space", + "lua" : "ArdourUI:Editor:maximise_editing_space", "ret" : "void", "decl" : "void (PublicEditor::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:restore_editing_space", + "lua" : "ArdourUI:Editor:restore_editing_space", "ret" : "void", "decl" : "void (PublicEditor::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:toggle_meter_updating", + "lua" : "ArdourUI:Editor:toggle_meter_updating", "ret" : "void", "decl" : "void (PublicEditor::*)()" }, {"type" : "Member Function RefReturn", - "lua" : "ARDOUR:Editor:get_nudge_distance", + "lua" : "ArdourUI:Editor:get_nudge_distance", "ret" : "long", "decl" : "long (PublicEditor::*)(long, long&)" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:get_paste_offset", + "lua" : "ArdourUI:Editor:get_paste_offset", "ret" : "long", "decl" : "long (PublicEditor::*)(long, unsigned int, long)" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:get_grid_beat_divisions", + "lua" : "ArdourUI:Editor:get_grid_beat_divisions", "ret" : "unsigned int", "decl" : "unsigned int (PublicEditor::*)(long)" }, {"type" : "Member Function RefReturn", - "lua" : "ARDOUR:Editor:get_grid_type_as_beats", + "lua" : "ArdourUI:Editor:get_grid_type_as_beats", "ret" : "Evoral::Beats", "decl" : "Evoral::Beats (PublicEditor::*)(bool&, long)" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:toggle_ruler_video", + "lua" : "ArdourUI:Editor:toggle_ruler_video", "ret" : "void", "decl" : "void (PublicEditor::*)(bool)" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:toggle_xjadeo_proc", + "lua" : "ArdourUI:Editor:toggle_xjadeo_proc", "ret" : "void", "decl" : "void (PublicEditor::*)(int)" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:get_videotl_bar_height", + "lua" : "ArdourUI:Editor:get_videotl_bar_height", "ret" : "int", "decl" : "int (PublicEditor::*)()" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:set_video_timeline_height", + "lua" : "ArdourUI:Editor:set_video_timeline_height", "ret" : "void", "decl" : "void (PublicEditor::*)(int)" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:center_screen", + "lua" : "ArdourUI:Editor:center_screen", "ret" : "void", "decl" : "void (PublicEditor::*)(long)" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:get_smart_mode", + "lua" : "ArdourUI:Editor:get_smart_mode", "ret" : "bool", "decl" : "bool (PublicEditor::*)()" }, {"type" : "Member Function RefReturn", - "lua" : "ARDOUR:Editor:get_pointer_position", + "lua" : "ArdourUI:Editor:get_pointer_position", "ret" : "void", "decl" : "void (PublicEditor::*)(double&, double&)" }, {"type" : "Member Function RefReturn", - "lua" : "ARDOUR:Editor:find_location_from_marker", + "lua" : "ArdourUI:Editor:find_location_from_marker", "ret" : "ARDOUR::Location*", "decl" : "ARDOUR::Location* (PublicEditor::*)(ArdourMarker*, bool&)" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:find_marker_from_location_id", + "lua" : "ArdourUI:Editor:find_marker_from_location_id", "ret" : "ArdourMarker*", "decl" : "ArdourMarker* (PublicEditor::*)(PBD::ID, bool)" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:mouse_add_new_marker", + "lua" : "ArdourUI:Editor:mouse_add_new_marker", "ret" : "void", "decl" : "void (PublicEditor::*)(long, bool)" }, {"type" : "Member Function", - "lua" : "ARDOUR:Editor:access_action", + "lua" : "ArdourUI:Editor:access_action", "ret" : "void", "decl" : "void (PublicEditor::*)(std::string, std::string)" }, diff --git a/tools/fmt-luadoc.php b/tools/fmt-luadoc.php index 4a8940f30d..279225816a 100755 --- a/tools/fmt-luadoc.php +++ b/tools/fmt-luadoc.php @@ -202,7 +202,7 @@ foreach ($doc as $b) { switch (stripclass($ns, $b['lua'])) { case 'add': $args = array (array ('LuaTable {'.$templ[1].'}' => 0)); - $ret = array ('void' => 0); + $ret = array ('LuaTable' => 0); break; case 'iter': $args = array (); @@ -235,6 +235,7 @@ foreach ($doc as $b) { } } $classlist[luafn2class ($b['lua'])]['func'][] = array ( + 'bind' => $b, 'name' => $b['lua'], 'args' => $args, 'ret' => $ret, @@ -245,6 +246,7 @@ foreach ($doc as $b) { case "Free Function": case "Free Function RefReturn": $funclist[luafn2class ($b['lua'])][] = array ( + 'bind' => $b, 'name' => $b['lua'], 'args' => decl2args ($b['decl']), 'ret' => arg2lua ($b['ret']), @@ -261,6 +263,7 @@ foreach ($doc as $b) { case "Static Member Function": checkclass ($b); $classlist[luafn2class ($b['lua'])]['func'][] = array ( + 'bind' => $b, 'name' => $b['lua'], 'args' => decl2args ($b['decl']), 'ret' => arg2lua ($b['ret']), @@ -380,7 +383,9 @@ function typelink ($a, $short = false, $argcls = '', $linkcls = '', $suffix = '' global $constlist; # all cross-reference links are generated here. # currently anchors on a single page. - if (in_array ($a, array_keys ($classlist))) { + if (isset($classlist[$a]['free'])) { + return ''.($short ? shortname($a) : ctorname($a)).$suffix.''; + } else if (in_array ($a, array_keys ($classlist))) { return ''.($short ? shortname($a) : htmlentities($a)).$suffix.''; } else if (in_array ($a, array_keys ($constlist))) { return ''.($short ? shortname($a) : ctorname($a)).$suffix.''; @@ -442,7 +447,7 @@ function format_class_members ($ns, $cl, &$dups) { $rv.= typelink (varname ($f['ret']), true, 'em'); } $rv.= ''; - $rv.= ''.stripclass ($ns, $f['name']).''; + $rv.= ''.stripclass ($ns, $f['name']).''; $rv.= format_args ($f['args']); $rv.= ''.NL; } @@ -488,6 +493,7 @@ table.classmembers td.def { text-align:right; padding-right:.5em; white-space: table.classmembers td.decl { text-align:left; padding-left:.5em; white-space: nowrap; } table.classmembers td.fill { width: 99%;} table.classmembers span.em { font-style: italic;} +span.functionname abbr { text-decoration:none; cursor:default;} div.header {text-align:center;} div.header h1 {margin:0;} div.header p {margin:.25em;} @@ -529,16 +535,16 @@ foreach ($classlist as $ns => $cl) { # format class title if (empty ($tbl)) { - echo '

∅ '.$ns.'

'.NL; + echo '

∅ '.htmlentities ($ns).'

'.NL; } else if (isset ($classlist[$ns]['free'])) { - echo '

ℕ '.$ns.'

'.NL; + echo '

ℕ '.ctorname($ns).'

'.NL; } else if (isset ($classlist[$ns]['arr'])) { - echo '

⋯ '.$ns.'

'.NL; + echo '

⋯ '.htmlentities ($ns).'

'.NL; } else if (isset ($classlist[$ns]['ptr'])) { - echo '

↠ '.$ns.'

'.NL; + echo '

↠ '. htmlentities ($ns).'

'.NL; } else { echo '

∁ '.htmlentities ($ns).'

'.NL; } -- 2.30.2