From 721e67ba8c44d942d8f54819930498f2321b6bfb Mon Sep 17 00:00:00 2001 From: Julien Danjou Date: Mon, 26 May 2008 20:24:26 +0200 Subject: [PATCH] [doc] Add header in API section --- awesomerc.5.txt | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/awesomerc.5.txt b/awesomerc.5.txt index 889a7cd8..bb222ee1 100644 --- a/awesomerc.5.txt +++ b/awesomerc.5.txt @@ -20,6 +20,12 @@ This file is read at startup. AWESOME LUA API --------------- +Each function available in awesome Lua implementation is listed below. +Function named package.function are relative to the package and must be called +as is. +Function named object_type:function are objects methods and must be applied on +object with type "object_type". + include::apidocgen.txt[] SEE ALSO