EnglishFrenchSpanish

Ad


OnWorks favicon

ldoc - Online in the Cloud

Run ldoc in OnWorks free hosting provider over Ubuntu Online, Fedora Online, Windows online emulator or MAC OS online emulator

This is the command ldoc that can be run in the OnWorks free hosting provider using one of our multiple free online workstations such as Ubuntu Online, Fedora Online, Windows online emulator or MAC OS online emulator

PROGRAM:

NAME


ldoc - A LuaDoc-compatible documentation generation system

DESCRIPTION


LDoc, a documentation generator for Lua compatible to LuaDoc.

OPTIONS


-d, --dir
(default docs) output directory

-o, --output
(default 'index') output name

-v, --verbose
be verbose during doc generation

-a, --all
show local functions, etc, in docs

-q, --quiet
suppress output

-m, --module
module docs as text

-s, --style
(default !) directory for style sheet (ldoc.css)

-l, --template
(default !) directory for template (ldoc.ltp)

-p, --project
(default ldoc) project name

-t, --title
(default Reference) page title

-f, --format
(default plain) formatting, valid options are markdown, discount or plain

-b, --package
(default .) top-level package basename (needed for module(...))

-x, --ext
(default html) output file extension

-c, --config
(default config.ld) configuration name

-i, --ignore
ignore any 'no doc comment or no module' warnings

-X, --not_luadoc
break LuaDoc compatibility. Descriptions may continue after tags.

-D, --define
(default none) set a flag to be used in config.ld

-C, --colon
use colon style

-B, --boilerplate
ignore first comment in source files

-M, --merge
allow module merging

-S, --simple
no return or params, no summary

-O, --one
one-column output layout

--dump debug output dump

--filter
(default none) filter output as Lua data (e.g pl.pretty.dump)

--tags (default none) show all references to given tags, comma-separated

<file> (string) source file or directory containing source

EXAMPLES


ldoc . reads options from a config.ld file in the same directory

ldoc -c path/to/myconfig.ld .
reads options from path/to/myconfig.ld

Use ldoc online using onworks.net services


Free Servers & Workstations

Download Windows & Linux apps

  • 1
    Clover EFI bootloader
    Clover EFI bootloader
    Project has moved to
    https://github.com/CloverHackyColor/CloverBootloader..
    Features:Boot macOS, Windows, and Linux
    in UEFI or legacy mode on Mac or PC with
    UE...
    Download Clover EFI bootloader
  • 2
    unitedrpms
    unitedrpms
    Join us in Gitter!
    https://gitter.im/unitedrpms-people/Lobby
    Enable the URPMS repository in your
    system -
    https://github.com/UnitedRPMs/unitedrpms.github.io/bl...
    Download unitedrpms
  • 3
    Boost C++ Libraries
    Boost C++ Libraries
    Boost provides free portable
    peer-reviewed C++ libraries. The
    emphasis is on portable libraries which
    work well with the C++ Standard Library.
    See http://www.bo...
    Download Boost C++ Libraries
  • 4
    VirtualGL
    VirtualGL
    VirtualGL redirects 3D commands from a
    Unix/Linux OpenGL application onto a
    server-side GPU and converts the
    rendered 3D images into a video stream
    with which ...
    Download VirtualGL
  • 5
    libusb
    libusb
    Library to enable user space
    application programs to communicate with
    USB devices. Audience: Developers, End
    Users/Desktop. Programming Language: C.
    Categories...
    Download libusb
  • 6
    SWIG
    SWIG
    SWIG is a software development tool
    that connects programs written in C and
    C++ with a variety of high-level
    programming languages. SWIG is used with
    different...
    Download SWIG
  • More »

Linux commands

Ad