From bd907bc81589a03e6c0945f58c77944319a890d5 Mon Sep 17 00:00:00 2001
From: Tom Feist <shabble@cowu.be>
Date: Fri, 9 Jul 2010 22:48:31 +0100
Subject: initial podifying of irssi docs

---
 docs/Irssi.pm                       | 52 +++++++++++++++++++++++++++++++++++++
 docs/Irssi/TextUI.pm                |  0
 docs/Irssi/TextUI/Line.pm           |  0
 docs/Irssi/TextUI/LineCache.pm      |  0
 docs/Irssi/TextUI/LineInfo.pm       |  0
 docs/Irssi/TextUI/MainWindow.pm     |  0
 docs/Irssi/TextUI/StatusbarItem.pm  |  0
 docs/Irssi/TextUI/TextBufferView.pm |  0
 docs/Irssi/TextUI/Textbuffer.pm     |  0
 docs/Irssi/UI/Window.pm             |  0
 docs/Signals.pm                     | 48 ++++++++++++++++++++++++++++++++++
 11 files changed, 100 insertions(+)
 create mode 100644 docs/Irssi.pm
 create mode 100644 docs/Irssi/TextUI.pm
 create mode 100644 docs/Irssi/TextUI/Line.pm
 create mode 100644 docs/Irssi/TextUI/LineCache.pm
 create mode 100644 docs/Irssi/TextUI/LineInfo.pm
 create mode 100644 docs/Irssi/TextUI/MainWindow.pm
 create mode 100644 docs/Irssi/TextUI/StatusbarItem.pm
 create mode 100644 docs/Irssi/TextUI/TextBufferView.pm
 create mode 100644 docs/Irssi/TextUI/Textbuffer.pm
 create mode 100644 docs/Irssi/UI/Window.pm
 create mode 100644 docs/Signals.pm

diff --git a/docs/Irssi.pm b/docs/Irssi.pm
new file mode 100644
index 0000000..c52fbc5
--- /dev/null
+++ b/docs/Irssi.pm
@@ -0,0 +1,52 @@
+__END__
+
+=head1 NAME
+
+=head1 DESCRIPTION
+
+=head1 CLASSES
+
+=head1 METHODS
+
+=head2 Accessors
+
+=over
+
+=item C<Irssi::active_win> -- returns the currently active L<Irssi::Window> object.
+
+=back
+
+
+=head2 Signals
+
+=head3 Handling Signals
+
+=head3 Controlling Signal Propagation
+
+=head3 Registering New Signals
+
+
+
+
+
+=head2 Commands
+
+=head3 Registering Commands
+
+=head3 Invoking Commands
+
+=head3 Parsing Command Arguments
+
+
+
+=head2 Settings
+
+=head3 Creating New Settings
+
+=head3 Retrieving Settings
+
+=head3 Modifying Settings
+
+
+
+=head2 blahblah
diff --git a/docs/Irssi/TextUI.pm b/docs/Irssi/TextUI.pm
new file mode 100644
index 0000000..e69de29
diff --git a/docs/Irssi/TextUI/Line.pm b/docs/Irssi/TextUI/Line.pm
new file mode 100644
index 0000000..e69de29
diff --git a/docs/Irssi/TextUI/LineCache.pm b/docs/Irssi/TextUI/LineCache.pm
new file mode 100644
index 0000000..e69de29
diff --git a/docs/Irssi/TextUI/LineInfo.pm b/docs/Irssi/TextUI/LineInfo.pm
new file mode 100644
index 0000000..e69de29
diff --git a/docs/Irssi/TextUI/MainWindow.pm b/docs/Irssi/TextUI/MainWindow.pm
new file mode 100644
index 0000000..e69de29
diff --git a/docs/Irssi/TextUI/StatusbarItem.pm b/docs/Irssi/TextUI/StatusbarItem.pm
new file mode 100644
index 0000000..e69de29
diff --git a/docs/Irssi/TextUI/TextBufferView.pm b/docs/Irssi/TextUI/TextBufferView.pm
new file mode 100644
index 0000000..e69de29
diff --git a/docs/Irssi/TextUI/Textbuffer.pm b/docs/Irssi/TextUI/Textbuffer.pm
new file mode 100644
index 0000000..e69de29
diff --git a/docs/Irssi/UI/Window.pm b/docs/Irssi/UI/Window.pm
new file mode 100644
index 0000000..e69de29
diff --git a/docs/Signals.pm b/docs/Signals.pm
new file mode 100644
index 0000000..0ea689f
--- /dev/null
+++ b/docs/Signals.pm
@@ -0,0 +1,48 @@
+__END__
+
+=head1 NAME
+
+Irssi Signal Documentation
+
+=head1 DESCRIPTION
+
+Perl POD documentation based on the doc/signals.txt documentation supplied with
+Irssi.
+
+=head1 USING SIGNALS
+
+See L<Irssi/"Signals">
+
+=head1 SIGNAL DEFINITIONS
+
+The following signals are categorised as in the original documentation, but
+have been revised to note Perl variable types and class names.
+
+Arguments are passed to signal handlers in the usual way, via C<@_>.
+
+=head2 Core
+
+=over 4
+
+=item C<"gui exit"> I<None>
+
+=item C<"gui dialog" string $type, string $text>
+
+=item C<"send command">
+C<string $command, Irssi::Server $server, Irssi::Windowitem
+$window_item>
+
+=back
+
+=head2 IRC Core
+
+=head2 IRC Module
+
+=head2 Display (FE) Common
+
+=head2 Display (FE) IRC
+
+=head2 Display (FE) Text
+
+=head2 Perl Scripting
+
-- 
cgit v1.2.3