ນີ້ແມ່ນຄໍາສັ່ງ ldoc ທີ່ສາມາດດໍາເນີນການໄດ້ໃນ OnWorks ຜູ້ໃຫ້ບໍລິການໂຮດຕິ້ງຟຣີໂດຍໃຊ້ຫນຶ່ງໃນຫຼາຍໆບ່ອນເຮັດວຽກອອນໄລນ໌ຂອງພວກເຮົາເຊັ່ນ Ubuntu Online, Fedora Online, Windows online emulator ຫຼື MAC OS online emulator
ໂຄງການ:
NAME
ldoc - ລະບົບການສ້າງເອກະສານທີ່ເຂົ້າກັນໄດ້ກັບ LuaDoc
ລາຍລະອຽດ
LDoc, ຜູ້ຜະລິດເອກະສານສໍາລັບ Lua ທີ່ເຂົ້າກັນໄດ້ກັບ LuaDoc.
OPTIONS
-d, --dir
(ເອກະສານເລີ່ມຕົ້ນ) ໄດເລກະທໍລີຜົນຜະລິດ
-o, -- ຜົນຜະລິດ
(ຄ່າເລີ່ມຕົ້ນ 'index') ຊື່ຜົນຜະລິດ
- ໃນ, -- verbose
be verbose ໃນໄລຍະການຜະລິດ doc
-ກ, --ທັງໝົດ
ສະແດງຟັງຊັນທ້ອງຖິ່ນ, ແລະອື່ນໆ, ໃນເອກະສານ
-q, --ງຽບ
ສະກັດກັ້ນຜົນຜະລິດ
-m, --ໂມດູນ
ໂມດູນ docs ເປັນຂໍ້ຄວາມ
- ແມ່ນແລ້ວ, --ແບບ
(ຄ່າເລີ່ມຕົ້ນ !) ໄດເຣັກທໍຣີສຳລັບສະໄຕລ໌ຊີດ (ldoc.css)
-l, --ແມ່ແບບ
(ຄ່າເລີ່ມຕົ້ນ !) ໄດເຣັກທໍຣີສຳລັບແມ່ແບບ (ldoc.ltp)
-p, -- ໂຄງການ
(ຄ່າເລີ່ມຕົ້ນ ldoc) ຊື່ໂຄງການ
-t, --ຫົວຂໍ້
(ເອກະສານອ້າງອີງເລີ່ມຕົ້ນ) ຊື່ໜ້າ
-f, -- ຮູບແບບ
(default plain) ການຈັດຮູບແບບ, ທາງເລືອກທີ່ຖືກຕ້ອງແມ່ນ markdown, ສ່ວນຫຼຸດຫຼືທໍາມະດາ
-b, --ຊຸດ
(ຄ່າເລີ່ມຕົ້ນ .) ຊື່ແພັກເກັດລະດັບເທິງສຸດ (ຕ້ອງການສໍາລັບ ໂມດູນ(... ))
-x, --ຕໍ່
(html ເລີ່ມຕົ້ນ) ການຂະຫຍາຍໄຟລ໌ຜົນຜະລິດ
-c, --config
(default config.ld) ຊື່ການຕັ້ງຄ່າ
-i, --ບໍ່ສົນໃຈ
ບໍ່ສົນໃຈຄໍາເຕືອນ 'ບໍ່ມີ doc comment ຫຼືບໍ່ມີ module'
-X, --not_luadoc
ທໍາລາຍຄວາມເຂົ້າກັນໄດ້ LuaDoc. ຄຳອະທິບາຍອາດຈະສືບຕໍ່ຫຼັງຈາກແທັກ.
-D, -- ກໍານົດ
(ບໍ່ມີຄ່າເລີ່ມຕົ້ນ) ຕັ້ງທຸງທີ່ຈະໃຊ້ໃນ config.ld
-C, -- ຈໍ້າສອງເມັດ
ໃຊ້ຮູບແບບຈໍ້າສອງເມັດ
-B, -- ແຜ່ນຫມໍ້
ບໍ່ສົນໃຈຄໍາເຫັນທໍາອິດໃນໄຟລ໌ຕົ້ນສະບັບ
-M, --ລວມເຂົ້າກັນ
ອະນຸຍາດໃຫ້ມີການລວມຕົວຂອງໂມດູນ
-S, --ງ່າຍດາຍ
ບໍ່ມີຜົນຕອບແທນຫຼື params, ບໍ່ມີບົດສະຫຼຸບ
-ໂອ, --ຫນຶ່ງ
ຮູບແບບຜົນຜະລິດຖັນດຽວ
-- ຖິ້ມ debug output dump
--ການກັ່ນຕອງ
(ບໍ່ມີຄ່າເລີ່ມຕົ້ນ) ການກັ່ນຕອງຜົນຜະລິດເປັນຂໍ້ມູນ Lua (ເຊັ່ນ: pl.pretty.dump)
--ແທັກ (ບໍ່ມີຄ່າເລີ່ມຕົ້ນ) ສະແດງໃຫ້ເຫັນການອ້າງອີງທັງຫມົດທີ່ໃຫ້ tags, ການແຍກດ້ວຍເຄື່ອງຫມາຍຈຸດ
(string) ແຫຼ່ງໄຟລ໌ຫຼືໄດເລກະທໍລີທີ່ມີແຫຼ່ງ
ຕົວຢ່າງ
ldoc . ອ່ານຕົວເລືອກຈາກໄຟລ໌ config.ld ໃນໄດເລກະທໍລີດຽວກັນ
ldoc -c path/to/myconfig.ld .
ອ່ານຕົວເລືອກຈາກ path/to/myconfig.ld
ໃຊ້ ldoc ອອນໄລນ໌ໂດຍໃຊ້ບໍລິການ onworks.net
