From c2252b6c67df64995b336c27fb175d504af20675 Mon Sep 17 00:00:00 2001
From: Tom Feist <shabble@cowu.be>
Date: Wed, 21 Jul 2010 17:25:07 +0100
Subject: added some stuff to the guide, and cleaned up some irssi.pod function
 descs

---
 docs/Irssi/UI/Window.pod | 96 +++++++++++++++++++++++++++++-------------------
 1 file changed, 59 insertions(+), 37 deletions(-)

(limited to 'docs/Irssi/UI')

diff --git a/docs/Irssi/UI/Window.pod b/docs/Irssi/UI/Window.pod
index a00827e..aa601a8 100644
--- a/docs/Irssi/UI/Window.pod
+++ b/docs/Irssi/UI/Window.pod
@@ -6,7 +6,8 @@ Irssi::UI::Window
 
 =head1 FIELDS
 
-UI::Window->{}
+C<UI::Window-E<gt>{}>
+
   refnum - Reference number
   name - Name
 
@@ -33,7 +34,8 @@ UI::Window->{}
 
   theme_name - Active theme in window, undef = default
 
-UI::TextDest->{}
+C<UI::TextDest-E<gt>{}>
+
   window - Window where the text will be written
   server - Target server
   target - Target channel/query/etc name
@@ -45,72 +47,92 @@ UI::TextDest->{}
 
 =head1 METHODS
 
-Window::command(cmd)
-Window::print(str[, level])
+=head2 C<command $cmd>
 
+=head2 C<print $str, [$level]>
 
-Window::items()
-  Return a list of items in window.
+=head2 C<items>
+
+Return a list of items in window.
 
-Window
-window_create(automatic)
-Windowitem::window_create(automatic)
-  Create a new window.
 
-Window::destroy()
-  Destroy the window.
+=head2 C<window_create $automatic>
+
+=head2 C<destroy>
+
+Destroy the window.
 
 Irssi::Window
 Windowitem::window()
   Returns parent window for window item.
 
-Window
-window_find_name(name)
-  Find window with name.
+=head2 C<window_find_name $name>
 
-Window
-window_find_refnum(refnum)
-  Find window with reference number.
+Find window with name.L<Irssi::UI::Window>
+
+=head2 C<window_find_refnum $refnum>
+
+Find window with reference number.
 
 Window
 window_find_level(level)
+
 Server::window_find_level(level)
   Find window with level.
 
 Window
 window_find_closest(name, level)
+
 Server::window_find_closest(name, level)
   Find window that matches best to given arguments. `name' can be either
   window name or name of one of the window items.
 
 Window
 window_find_item(name)
+
 Server::window_find_item(name)
   Find window which contains window item with specified name/server.
 
 
-Window::item_add(item, automatic)
-Window::item_remove(item)
-Window::item_destroy(item)
-  Add/remove/destroy window item
+=head2 C<item_add $item, $automatic>
+
+Add specified windowitem
+
+=head2 C<item_remove $item>
+
+remove specified windowitem
+
+=head2 C<item_destroy $item>
+
+destroy specified windowitem
+
+=head2 C<set_active>
+
+Set window active.
+
+=head2 C<change_server $server>
+
+=head2 C<set_refnum $refnum>
+
+=head2 C<set_name $name>
+
+=head2 C<set_history $name>
+
+=head2 C<set_level $level>
+
+Change server/refnum/name/history/level in window.
+
+=head2 C<item_prev>
+
+=head2 C<item_next>
 
-Window::set_active()
-  Set window active.
+Change to previous/next window item.
 
-Window::change_server(server)
-Window::set_refnum(refnum)
-Window::set_name(name)
-Window::set_history(name)
-Window::set_level(level)
-  Change server/refnum/name/history/level in window.
 
-Window::item_prev()
-Window::item_next()
-  Change to previous/next window item.
+=head2 C<get_active_name>
 
+Return active item's name, or if none is active, window's name
 
-Window::get_active_name()
-  Return active item's name, or if none is active, window's name
+=head2 C<item_find $server, $name>
 
-Window::item_find(server, name)
-  Find window item that matches best to given arguments.
+Find window item that matches best to given arguments.
-- 
cgit v1.2.3