diff options
author | Tom Feist <shabble@cowu.be> | 2010-07-22 15:14:00 +0000 |
---|---|---|
committer | Tom Feist <shabble@cowu.be> | 2010-07-22 15:14:00 +0000 |
commit | 7f6988902700bfa9108b948b364f2f8f15fbbd55 (patch) | |
tree | e181299a72a8db03936a8ec95b9750feb5a04c97 /docs/Irssi | |
parent | added messagelevel docs to irssi.pod, more stuff in guide, and a little scrip... (diff) | |
download | irssi-scripts-7f6988902700bfa9108b948b364f2f8f15fbbd55.tar.gz irssi-scripts-7f6988902700bfa9108b948b364f2f8f15fbbd55.zip |
added additional packages and full function dumps to pod, unformatted so far
Diffstat (limited to 'docs/Irssi')
-rw-r--r-- | docs/Irssi/Ignore.pod | 8 | ||||
-rw-r--r-- | docs/Irssi/Irc.pod | 24 | ||||
-rw-r--r-- | docs/Irssi/Irc/Channel.pod | 16 | ||||
-rw-r--r-- | docs/Irssi/Irc/Dcc.pod | 7 | ||||
-rw-r--r-- | docs/Irssi/Irc/Server.pod | 26 | ||||
-rw-r--r-- | docs/Irssi/Log.pod | 5 | ||||
-rw-r--r-- | docs/Irssi/Query.pod | 10 | ||||
-rw-r--r-- | docs/Irssi/Server.pod | 31 | ||||
-rw-r--r-- | docs/Irssi/TextUI.pm | 1 | ||||
-rw-r--r-- | docs/Irssi/TextUI.pod | 12 | ||||
-rw-r--r-- | docs/Irssi/TextUI/Line.pod | 15 | ||||
-rw-r--r-- | docs/Irssi/TextUI/StatusbarItem.pod | 13 | ||||
-rw-r--r-- | docs/Irssi/TextUI/TextBufferView.pod | 25 | ||||
-rw-r--r-- | docs/Irssi/UI.pod | 13 | ||||
-rw-r--r-- | docs/Irssi/UI/Server.pod | 13 | ||||
-rw-r--r-- | docs/Irssi/UI/TextDest.pod | 11 | ||||
-rw-r--r-- | docs/Irssi/UI/Theme.pod | 8 | ||||
-rw-r--r-- | docs/Irssi/UI/Window.pod | 29 | ||||
-rw-r--r-- | docs/Irssi/Windowitem.pod | 16 |
19 files changed, 274 insertions, 9 deletions
diff --git a/docs/Irssi/Ignore.pod b/docs/Irssi/Ignore.pod index f93cbe3..6b0270a 100644 --- a/docs/Irssi/Ignore.pod +++ b/docs/Irssi/Ignore.pod @@ -6,7 +6,7 @@ Irssi::Ignore =head1 FIELDS -Ignore->{} +C<Ignore-E<gt>{}> mask - Ignore mask servertag - Ignore only in server @@ -21,3 +21,9 @@ Ignore->{} =head1 METHODS +B<TODO> + +=head2 C<add_rec> + +=head2 C<update_rec> + diff --git a/docs/Irssi/Irc.pod b/docs/Irssi/Irc.pod index e51b190..e654f59 100644 --- a/docs/Irssi/Irc.pod +++ b/docs/Irssi/Irc.pod @@ -12,6 +12,29 @@ Irssi::Irc =head1 METHODS +=head2 TODO + + Irssi::Irc::dcc_chat_find_id + Irssi::Irc::dcc_chat_send + Irssi::Irc::dcc_ctcp_message + Irssi::Irc::dcc_find_request + Irssi::Irc::dcc_find_request_latest + Irssi::Irc::dcc_get_download_path + Irssi::Irc::dcc_register_type + Irssi::Irc::dcc_str2type + Irssi::Irc::dcc_type2str + Irssi::Irc::dcc_unregister_type + Irssi::Irc::dccs + Irssi::Irc::deinit + Irssi::Irc::get_mask + Irssi::Irc::init + Irssi::Irc::modes_join + Irssi::Irc::notifies + Irssi::Irc::notifylist_add + Irssi::Irc::notifylist_find + Irssi::Irc::notifylist_ison + Irssi::Irc::notifylist_remove + =head2 Accessors =head3 C<dccs> @@ -25,3 +48,4 @@ project|http://irssi.org>. Formatting to POD and linking by Tom Feist L<shabble+irssi@metavore.org|mailto:shabble+irssi@metavore.org> + diff --git a/docs/Irssi/Irc/Channel.pod b/docs/Irssi/Irc/Channel.pod new file mode 100644 index 0000000..02488d1 --- /dev/null +++ b/docs/Irssi/Irc/Channel.pod @@ -0,0 +1,16 @@ +__END__ + +=head1 NAME + +Irssi::Irc::Channel + +=head1 FIELDS + +=head1 METHODS + + Irssi::Irc::Channel::ban_get_mask + Irssi::Irc::Channel::banlist_add + Irssi::Irc::Channel::banlist_remove + Irssi::Irc::Channel::bans + Irssi::Irc::Channel::nick_insert + diff --git a/docs/Irssi/Irc/Dcc.pod b/docs/Irssi/Irc/Dcc.pod index 5ba52b9..e3b5b99 100644 --- a/docs/Irssi/Irc/Dcc.pod +++ b/docs/Irssi/Irc/Dcc.pod @@ -70,3 +70,10 @@ Send `data' to dcc chat. =head2 C<ctcp_message $target, $notice, $msg> Send a CTCP message/notify to target. + +=head2 C<close> + +=head2 C<init_rec> + +=head2 C<reject> + diff --git a/docs/Irssi/Irc/Server.pod b/docs/Irssi/Irc/Server.pod new file mode 100644 index 0000000..520bf8d --- /dev/null +++ b/docs/Irssi/Irc/Server.pod @@ -0,0 +1,26 @@ +__END__ + +=head1 NAME + +Irssi::Irc::Server + +=head1 FIELDS + +=head1 METHODS + + Irssi::Irc::Server::ctcp_send_reply + Irssi::Irc::Server::get_channels + Irssi::Irc::Server::isupport + Irssi::Irc::Server::netsplit_find + Irssi::Irc::Server::netsplit_find_channel + Irssi::Irc::Server::notifylist_ison_server + Irssi::Irc::Server::query_create + Irssi::Irc::Server::redirect_event + Irssi::Irc::Server::redirect_get_signal + Irssi::Irc::Server::redirect_peek_signal + Irssi::Irc::Server::redirect_register + Irssi::Irc::Server::send_raw + Irssi::Irc::Server::send_raw_first + Irssi::Irc::Server::send_raw_now + Irssi::Irc::Server::send_raw_split + diff --git a/docs/Irssi/Log.pod b/docs/Irssi/Log.pod index 68163a2..c319654 100644 --- a/docs/Irssi/Log.pod +++ b/docs/Irssi/Log.pod @@ -48,3 +48,8 @@ Remove log item from log. =head2 C<item_find $type, $item, $server> Find item from log. Returns L<Irssi::Logitem> + +=head2 C<write_rec> + +I<Undocumented> + diff --git a/docs/Irssi/Query.pod b/docs/Irssi/Query.pod index c823a4a..cb7e0d8 100644 --- a/docs/Irssi/Query.pod +++ b/docs/Irssi/Query.pod @@ -20,9 +20,11 @@ Query->{} =head1 METHODS -Query::destroy() - Destroy the query. +=head2 C<destroy> -Query::query_change_server(server) - Change the active server of the query. +Destroy the query. + +=head2 C<query_change_server $server> + +Change the active server of the query. diff --git a/docs/Irssi/Server.pod b/docs/Irssi/Server.pod index 0832d97..e8ca3c1 100644 --- a/docs/Irssi/Server.pod +++ b/docs/Irssi/Server.pod @@ -116,3 +116,34 @@ Return all L<nick|Irssi::Nick> objects in all channels in server. List is in format: Channel, Nick, Channel, ... + + +=head1 FULL LIST OF FUNCS + + Irssi::Server::channel_find + Irssi::Server::channels + Irssi::Server::channels_join + Irssi::Server::command + Irssi::Server::disconnect + Irssi::Server::format_create_dest + Irssi::Server::get_nick_flags + Irssi::Server::ignore_check + Irssi::Server::ischannel + Irssi::Server::isnickflag + Irssi::Server::mask_match + Irssi::Server::mask_match_address + Irssi::Server::masks_match + Irssi::Server::nicks_get_same + Irssi::Server::parse_special + Irssi::Server::print + Irssi::Server::printformat + Irssi::Server::queries + Irssi::Server::query_find + Irssi::Server::ref + Irssi::Server::send_message + Irssi::Server::unref + Irssi::Server::window_find_closest + Irssi::Server::window_find_item + Irssi::Server::window_find_level + Irssi::Server::window_item_find + diff --git a/docs/Irssi/TextUI.pm b/docs/Irssi/TextUI.pm deleted file mode 100644 index f66cf7a..0000000 --- a/docs/Irssi/TextUI.pm +++ /dev/null @@ -1 +0,0 @@ -=head1 Empty diff --git a/docs/Irssi/TextUI.pod b/docs/Irssi/TextUI.pod index e69de29..7993274 100644 --- a/docs/Irssi/TextUI.pod +++ b/docs/Irssi/TextUI.pod @@ -0,0 +1,12 @@ +__END__ + +=head1 NAME + +Irssi::TextUI + +=head1 FIELDS + +=head1 METHODS + + Irssi::TextUI::deinit + Irssi::TextUI::init diff --git a/docs/Irssi/TextUI/Line.pod b/docs/Irssi/TextUI/Line.pod index 08bdae1..4c29dca 100644 --- a/docs/Irssi/TextUI/Line.pod +++ b/docs/Irssi/TextUI/Line.pod @@ -1,3 +1,16 @@ __END__ -=head1 Empty +=head1 NAME + +Irssi::TextUI::Line + +=head1 FIELDS + +=head1 METHODS + +=head2 C<get_text> + +=head2 C<next> + +=head2 C<prev> + diff --git a/docs/Irssi/TextUI/StatusbarItem.pod b/docs/Irssi/TextUI/StatusbarItem.pod index 08bdae1..87de288 100644 --- a/docs/Irssi/TextUI/StatusbarItem.pod +++ b/docs/Irssi/TextUI/StatusbarItem.pod @@ -1,3 +1,14 @@ __END__ -=head1 Empty +=head1 NAME + +Irssi::TextUI::StatusbarItem + +=head1 FIELDS + +=head1 METHODS + +=head2 C<default_handler> + +I<undocumented> + diff --git a/docs/Irssi/TextUI/TextBufferView.pod b/docs/Irssi/TextUI/TextBufferView.pod index 08bdae1..f42d362 100644 --- a/docs/Irssi/TextUI/TextBufferView.pod +++ b/docs/Irssi/TextUI/TextBufferView.pod @@ -1,3 +1,26 @@ __END__ -=head1 Empty +=head1 NAME + +Irssi::TextUI::TextBufferView + +=head1 FIELDS + +=head1 METHODS + + Irssi::TextUI::TextBufferView::clear + Irssi::TextUI::TextBufferView::get_bookmark + Irssi::TextUI::TextBufferView::get_line_cache + Irssi::TextUI::TextBufferView::get_lines + Irssi::TextUI::TextBufferView::redraw + Irssi::TextUI::TextBufferView::remove_all_lines + Irssi::TextUI::TextBufferView::remove_line + Irssi::TextUI::TextBufferView::scroll + Irssi::TextUI::TextBufferView::scroll_line + Irssi::TextUI::TextBufferView::set_bookmark + Irssi::TextUI::TextBufferView::set_bookmark_bottom + Irssi::TextUI::TextBufferView::set_default_indent + Irssi::TextUI::TextBufferView::set_scroll + +I<undocumented> + diff --git a/docs/Irssi/UI.pod b/docs/Irssi/UI.pod new file mode 100644 index 0000000..aac1c6e --- /dev/null +++ b/docs/Irssi/UI.pod @@ -0,0 +1,13 @@ +__END__ + +=head1 NAME + +Irssi::UI + +=head1 FIELDS + +=head1 METHODS + + Irssi::UI::deinit + Irssi::UI::init + Irssi::UI::processes diff --git a/docs/Irssi/UI/Server.pod b/docs/Irssi/UI/Server.pod new file mode 100644 index 0000000..7bc7080 --- /dev/null +++ b/docs/Irssi/UI/Server.pod @@ -0,0 +1,13 @@ +__END__ + +=head1 NAME + +Irssi::UI::Server + +=head1 FIELDS + +=head1 METHODS + + Irssi::UI::Server::gui_printtext_after + Irssi::UI::Server::term_refresh_freeze + Irssi::UI::Server::term_refresh_thaw diff --git a/docs/Irssi/UI/TextDest.pod b/docs/Irssi/UI/TextDest.pod new file mode 100644 index 0000000..24b9d04 --- /dev/null +++ b/docs/Irssi/UI/TextDest.pod @@ -0,0 +1,11 @@ +__END__ + +=head1 NAME + +Irssi::UI::TextDest + +=head1 FIELDS + +=head1 METHODS + + Irssi::UI::TextDest::print diff --git a/docs/Irssi/UI/Theme.pod b/docs/Irssi/UI/Theme.pod index 2e69186..2d2b7f6 100644 --- a/docs/Irssi/UI/Theme.pod +++ b/docs/Irssi/UI/Theme.pod @@ -8,6 +8,14 @@ Irssi::UI::Theme =head1 METHODS +=head2 C<format_expand> + +I<undocumented> + +=head2 C<get_format> + +I<undocumented> + =head1 THEME DOCUMENTATION When testing changes, the easiest way to reload the theme is with /RELOAD. diff --git a/docs/Irssi/UI/Window.pod b/docs/Irssi/UI/Window.pod index aa601a8..2dd6389 100644 --- a/docs/Irssi/UI/Window.pod +++ b/docs/Irssi/UI/Window.pod @@ -136,3 +136,32 @@ Return active item's name, or if none is active, window's name =head2 C<item_find $server, $name> Find window item that matches best to given arguments. + +=head1 Full list of functions + + Irssi::UI::Window::activity + Irssi::UI::Window::change_server + Irssi::UI::Window::command + Irssi::UI::Window::destroy + Irssi::UI::Window::format_get_text + Irssi::UI::Window::get_active_name + Irssi::UI::Window::get_history_lines + Irssi::UI::Window::gui_printtext_after + Irssi::UI::Window::item_add + Irssi::UI::Window::item_destroy + Irssi::UI::Window::item_find + Irssi::UI::Window::item_next + Irssi::UI::Window::item_prev + Irssi::UI::Window::item_remove + Irssi::UI::Window::items + Irssi::UI::Window::last_line_insert + Irssi::UI::Window::print + Irssi::UI::Window::print_after + Irssi::UI::Window::printformat + Irssi::UI::Window::set_active + Irssi::UI::Window::set_history + Irssi::UI::Window::set_level + Irssi::UI::Window::set_name + Irssi::UI::Window::set_refnum + Irssi::UI::Window::view + diff --git a/docs/Irssi/Windowitem.pod b/docs/Irssi/Windowitem.pod index 45cde9c..896600b 100644 --- a/docs/Irssi/Windowitem.pod +++ b/docs/Irssi/Windowitem.pod @@ -60,3 +60,19 @@ returns L<Irssi::Dcc> object. Windowitem::window_create(automatic) Create a new window. + +=head1 full func list + + + Irssi::Windowitem::activity + Irssi::Windowitem::change_server + Irssi::Windowitem::command + Irssi::Windowitem::get_dcc + Irssi::Windowitem::is_active + Irssi::Windowitem::parse_special + Irssi::Windowitem::print + Irssi::Windowitem::printformat + Irssi::Windowitem::set_active + Irssi::Windowitem::window + Irssi::Windowitem::window_create + |