about summary refs log tree commit homepage
diff options
context:
space:
mode:
authorEric Wong <normalperson@yhbt.net>2013-10-28 06:00:25 +0000
committerEric Wong <normalperson@yhbt.net>2013-10-28 06:01:21 +0000
commit22b88ef0e1e21f208d4d4de3c56be29b5efcdc05 (patch)
tree6f691f0dc9e403093703e7843f6db1b066dc2ec5
parent5f67786b426c9c16408b5f7ce3209cd1710fc75c (diff)
downloadyahns-22b88ef0e1e21f208d4d4de3c56be29b5efcdc05.tar.gz
We will have no public API outside the config file.  Since this is a
*nix-only (and possibly Linux-only, even), manpages are
language-agnostic and easier for users (sysadmins) who may not be
familiar with Ruby/RDoc.  All *nix-based Rubyists I've encountered
are familiar with manpages, already.

We won't have to worry about users being confused by our docs strewn
across frames/CSS/JS-ridden sites like rdoc.info, either :)
-rw-r--r--.gitignore1
-rw-r--r--lib/yahns/tcp_server.rb2
-rw-r--r--lib/yahns/unix_server.rb2
3 files changed, 3 insertions, 2 deletions
diff --git a/.gitignore b/.gitignore
index da7576a..e557c9c 100644
--- a/.gitignore
+++ b/.gitignore
@@ -13,3 +13,4 @@
 .manifest
 .gem-manifest
 .tgz-manifest
+/doc
diff --git a/lib/yahns/tcp_server.rb b/lib/yahns/tcp_server.rb
index e650a2a..886dd4d 100644
--- a/lib/yahns/tcp_server.rb
+++ b/lib/yahns/tcp_server.rb
@@ -2,6 +2,6 @@
 # Copyright (C) 2013, Eric Wong <normalperson@yhbt.net> et. al.
 # License: GPLv3 or later (see COPYING for details)
 require_relative 'acceptor'
-class Yahns::TCPServer < Kgio::TCPServer
+class Yahns::TCPServer < Kgio::TCPServer # :nodoc:
   include Yahns::Acceptor
 end
diff --git a/lib/yahns/unix_server.rb b/lib/yahns/unix_server.rb
index 3269db3..3c36cd9 100644
--- a/lib/yahns/unix_server.rb
+++ b/lib/yahns/unix_server.rb
@@ -2,6 +2,6 @@
 # Copyright (C) 2013, Eric Wong <normalperson@yhbt.net> et. al.
 # License: GPLv3 or later (see COPYING for details)
 require_relative 'acceptor'
-class Yahns::UNIXServer < Kgio::UNIXServer
+class Yahns::UNIXServer < Kgio::UNIXServer # :nodoc:
   include Yahns::Acceptor
 end