The Ecere SDK - sdk/blob - share/man/man1/documentor.1

   1 .TH DOCUMENTOR "1" "August 2016" "documentor" "Ecere SDK/API Reference Tool"
   2 .SH NAME
   3 documentor \- Ecere API Reference Tool
   4 .SH SYNOPSIS
   5 .IX
   6 documentor [\fIec-shared-library-name-or-path\fR] | [\fIec-symbol-file\fR (\fB.sym\fR)]
   7 .SH DESCRIPTION
   8 Brings up the Ecere API Reference Tool.
   9
  10 Module (eC shared library or symbol file) whose API you want to browse and/or contribute to can be specified on the command line.
  11
  12 If no name is specified, the libecere API will show up by default.
  13
  14 Changes will be saved in the documentation path specified in the application's File/Settings menu (Defaults to /usr/share/ecere/doc), within the folder: \fImodule-name\fR.
  15
  16 Since version 0.44.15, documentation data is now stored using the \fBECON\fR data interchange format( http://ec-lang.org/econ/ ).
  17
  18 ECON is compatible with the eC instantiation syntax.