From 914cd06a7814f63de1701d79a659d28c438aabdb Mon Sep 17 00:00:00 2001
From: Benjamin Neff <benjamin@coding4coffee.ch>
Date: Fri, 19 Jun 2015 01:22:43 +0200
Subject: [PATCH] write more documentation

---
 .../diaspora_federation/application_controller.rb  |  2 ++
 .../diaspora_federation/receive_controller.rb      | 10 ++++++++++
 .../diaspora_federation/webfinger_controller.rb    | 14 ++++++++++++++
 3 files changed, 26 insertions(+)

diff --git a/app/controllers/diaspora_federation/application_controller.rb b/app/controllers/diaspora_federation/application_controller.rb
index 4db5f90..f625f08 100644
--- a/app/controllers/diaspora_federation/application_controller.rb
+++ b/app/controllers/diaspora_federation/application_controller.rb
@@ -1,4 +1,6 @@
 module DiasporaFederation
+  ##
+  # Base-Controller for all DiasporaFederation-Controller
   class ApplicationController < ActionController::Base
   end
 end
diff --git a/app/controllers/diaspora_federation/receive_controller.rb b/app/controllers/diaspora_federation/receive_controller.rb
index 5e5a7e9..5083260 100644
--- a/app/controllers/diaspora_federation/receive_controller.rb
+++ b/app/controllers/diaspora_federation/receive_controller.rb
@@ -1,15 +1,25 @@
 require_dependency "diaspora_federation/application_controller"
 
 module DiasporaFederation
+  ##
+  # this controller processes receiving messages
   class ReceiveController < ApplicationController
     before_action :check_for_xml
 
+    ##
+    # receives public messages
+    #
+    # POST /receive/public
     def public
       logger.info "received a public message"
       logger.debug CGI.unescape(params[:xml])
       render nothing: true, status: :ok
     end
 
+    ##
+    # receives private messages for a user
+    #
+    # POST /receive/users/:guid
     def private
       logger.info "received a private message for #{params[:guid]}"
       logger.debug CGI.unescape(params[:xml])
diff --git a/app/controllers/diaspora_federation/webfinger_controller.rb b/app/controllers/diaspora_federation/webfinger_controller.rb
index 0201d6f..2a53bed 100644
--- a/app/controllers/diaspora_federation/webfinger_controller.rb
+++ b/app/controllers/diaspora_federation/webfinger_controller.rb
@@ -1,7 +1,19 @@
 require_dependency "diaspora_federation/application_controller"
 
 module DiasporaFederation
+  ##
+  # this controller handles all webfinger-specific requests
   class WebfingerController < ApplicationController
+    ##
+    # returns the host-meta xml
+    #
+    # example:
+    #   <?xml version="1.0" encoding="UTF-8"?>
+    #   <XRD xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0">
+    #        <Link rel="lrdd" type="application/xrd+xml" template="https://server.example/webfinger?q={uri}"/>
+    #   </XRD>
+    #
+    # GET /.well-known/host-meta
     def host_meta
       doc = WebFinger::HostMeta.from_base_url(DiasporaFederation.server_uri.to_s)
       render body: doc.to_xml, content_type: "application/xrd+xml"
@@ -9,6 +21,8 @@ module DiasporaFederation
 
     ##
     # this is the pre RFC 7033 webfinger
+    #
+    # GET /webfinger?q={uri}
     def legacy_webfinger
       @person = find_person(params[:q]) if params[:q]