ນີ້ແມ່ນຄໍາສັ່ງ autogsdoc ທີ່ສາມາດດໍາເນີນການໄດ້ໃນ OnWorks ຜູ້ໃຫ້ບໍລິການໂຮດຕິ້ງຟຣີໂດຍໃຊ້ຫນຶ່ງໃນຫຼາຍໆບ່ອນເຮັດວຽກອອນໄລນ໌ຂອງພວກເຮົາເຊັ່ນ Ubuntu Online, Fedora Online, Windows online emulator ຫຼື MAC OS online emulator
ໂຄງການ:
NAME
autogsdoc - ຕົວສ້າງເອກະສານ GNUstep API ແລະຕົວແປງ XML->HTML
ສະຫຼຸບສັງລວມ
autogsdoc [- ໄຟລ໌ ຊື່ເອກະສານ] [- ສ້າງHtml ແມ່ນ|ບໍ່] [-ສະອາດ ແມ່ນ|ບໍ່] [- ແມ່ແບບທໍາຄວາມສະອາດ
ແມ່ນ|ບໍ່] [- ບໍ່ສົນໃຈການເພິ່ງພາອາໄສ ແມ່ນ|ບໍ່] [-MakeDependencies ແມ່ນ|ບໍ່] [-ShowDependencies ແມ່ນ|ບໍ່]
[-HeaderDirectory ເສັ້ນທາງ] [- DocumentationDirectory ເສັ້ນທາງ] [- ປະກາດ ສະຖານທີ່] [- ໂຄງການ
ຫົວຂໍ້] [- ມາດຕະຖານ ແມ່ນ|ບໍ່] [-DocumentAllInstanceVariables ແມ່ນ|ບໍ່]
[-DocumentInstanceVariables ແມ່ນ|ບໍ່] [-InstanceVariablesAtEnd ແມ່ນ|ບໍ່] [- ຕົວແບບຄົງທີ່
ຊື່ເອກະສານ] [-FunctionsTemplate ຊື່ເອກະສານ] [- ແມ່ແບບ Macros ຊື່ເອກະສານ] [-TypedefsTemplate
ຊື່ເອກະສານ] [- ຕົວແບບຕົວແປ ຊື່ເອກະສານ] [- ໂຄງການລະບົບ string] [- ໂຄງການທ້ອງຖິ່ນ string]
[- ໂຄງການ dictString] [- ຄຳເວົ້າ ແມ່ນ|ບໍ່] [- ເຕືອນ ແມ່ນ|ບໍ່] [- WordMap dictString] [ໄຟ]
ລາຍລະອຽດ
ເຄື່ອງມື autogsdoc ເປັນເຄື່ອງໃຊ້ຄໍາສັ່ງທີ່ຊ່ວຍໃຫ້ນັກພັດທະນາຜະລິດເອກະສານອ້າງອີງ
ເອກະສານສໍາລັບ GNUstep APIs. ມັນຍັງຊ່ວຍໃຫ້ນັກພັດທະນາສາມາດຂຽນແລະຮັກສາອື່ນໆ
ເອກະສານໃນ XML ແລະໃຫ້ມັນປ່ຽນເປັນ HTML. ລາຍລະອຽດ, autogsdoc ຈະ:
- ສະກັດຄວາມຄິດເຫັນພິເສດອະທິບາຍການໂຕ້ຕອບສາທາລະນະຂອງຫ້ອງຮຽນ, ປະເພດ,
ໂປໂຕຄອນ, ຟັງຊັນ, ແລະມະຫາພາກຈາກລະຫັດແຫຼ່ງ Objective C (ໄຟລ໌ສ່ວນຫົວ ແລະ
ແຫຼ່ງໄຟລ໌ທາງເລືອກ) ເຂົ້າໄປໃນໄຟລ໌ GSDoc XML.
- ແປງໄຟລ໌ GSDoc XML, ບໍ່ວ່າຈະສ້າງຈາກລະຫັດແຫຼ່ງຫຼືລາຍລັກອັກສອນດ້ວຍຕົນເອງໂດຍ
ນັກພັດທະນາ, ເຂົ້າໄປໃນ HTML.
- ສ້າງດັດຊະນີໂດຍອີງໃສ່ຊຸດໄຟລ໌ GSDoc XML, ແລະປ່ຽນເປັນ HTML ເຊັ່ນກັນ.
ການນໍາໃຊ້ທົ່ວໄປທີ່ສຸດນີ້ແມ່ນການດໍາເນີນການຄໍາສັ່ງທີ່ມີຫນຶ່ງຫຼືຫຼາຍຊື່ໄຟລ໌ header ເປັນ
arguments ... ເຄື່ອງມືຈະວິເຄາະໄຟລ໌ແຫຼ່ງທີ່ສອດຄ້ອງກັນໂດຍອັດຕະໂນມັດໃນອັນດຽວກັນ
ໄດເລກະທໍລີເປັນສ່ວນຫົວ (ຫຼືໄດເລກະທໍລີປະຈຸບັນ, ຫຼືໄດເລກະທໍລີທີ່ລະບຸໂດຍໃຊ້
DocumentationDirectory default), ແລະຜະລິດໄຟລ໌ GSDoc ແລະ HTML ເປັນຜົນຜະລິດ. ສໍາລັບທີ່ດີທີ່ສຸດ
ຜົນໄດ້ຮັບຮູບແບບນີ້ຄວນຈະຖືກດໍາເນີນການຈາກໄດເລກະທໍລີທີ່ມີໄຟລ໌ຕົ້ນສະບັບ. (ຫມາຍເຫດ
ເນື່ອງຈາກວ່າ C ເປັນຊຸດຍ່ອຍຂອງ Objective C, ເຄື່ອງມືນີ້ສາມາດປະຕິບັດຫນ້າທີ່ຂອງເອກະສານແລະ
ໂຄງສ້າງ C ອື່ນໆໃນແຫຼ່ງ C ທໍາມະດາ.)
ໄຟລ໌ GSDoc ອາດຈະໄດ້ຮັບໂດຍກົງນອກຈາກນັ້ນຫຼືດ້ວຍຕົນເອງ, ແລະຈະຖືກແປງ
ກັບ HTML. ເບິ່ງເອກະສານ GSDoc HTML ຫຼື gsdoc(7) man page ສໍາລັບຂໍ້ມູນກ່ຽວກັບ
ຮູບແບບ GSDoc.
ສຸດທ້າຍ, ໄຟລ໌ HTML ອາດຈະຖືກມອບໃຫ້ຢູ່ໃນເສັ້ນຄໍາສັ່ງ. ການອ້າງອິງຂ້າມກັບພາກສ່ວນອື່ນໆຂອງ
ເອກະສານລະຫັດທີ່ພົບເຫັນຢູ່ໃນພວກມັນຈະຖືກຂຽນຄືນໃຫມ່ໂດຍອີງໃສ່ສິ່ງທີ່ພົບເຫັນຢູ່ໃນ
ໂຄງການໃນປັດຈຸບັນ.
ແຫຼ່ງຂໍ້ມູນ CODE ມາກUP
ຕົວແຍກວິເຄາະລະຫັດແຫຼ່ງອັດຕະໂນມັດຈະຜະລິດເອກະສານ GSDoc ທີ່ລາຍຊື່ວິທີການໃນ
ຫ້ອງຮຽນທີ່ພົບເຫັນຢູ່ໃນໄຟລ໌ຕົ້ນສະບັບ, ແລະມັນຈະປະກອບມີຂໍ້ຄວາມຈາກຮູບແບບພິເສດ
ຄໍາເຫັນຈາກໄຟລ໌ແຫຼ່ງ.
ຄໍາເຫັນໃດໆທີ່ເລີ່ມຕົ້ນດ້ວຍ slash ແລະ ສອງ ດວງດາວແທນທີ່ຈະເປັນເຄື່ອງໝາຍສະໄລ້ທົ່ວໄປ ແລະດ່ຽວ
ດາວ, ຖືກເອົາເປັນເຄື່ອງໝາຍ GSDoc, ເພື່ອໃຊ້ເປັນລາຍລະອຽດຂອງຊັ້ນຮຽນ ຫຼືວິທີການ
ຕິດຕາມມັນ. ຂໍ້ຄວາມຄໍາເຫັນນີ້ແມ່ນໄດ້ຮັບການປັບຮູບແບບແລະຈາກນັ້ນໃສ່ເຂົ້າໄປໃນຜົນໄດ້ຮັບ.
ບ່ອນທີ່ຫຼາຍຄໍາເຫັນກ່ຽວຂ້ອງກັບລາຍການດຽວກັນ, ພວກມັນຖືກລວມເຂົ້າກັນກັບ a
ເສັ້ນແບ່ງ ( ) ລະຫວ່າງແຕ່ລະຄົນຖ້າຈໍາເປັນ.
ເຄື່ອງມືສາມາດຖືກນໍາໃຊ້ໄດ້ຢ່າງງ່າຍດາຍເພື່ອບັນດາໂຄງການເຊັ່ນດຽວກັນກັບຫ້ອງສະຫມຸດ, ພຽງແຕ່ໃຫ້ມັນ
ຊື່ຂອງໄຟລ໌ແຫຼ່ງທີ່ປະກອບດ້ວຍຫນ້າທີ່ຕົ້ນຕໍ () ຂອງໂຄງການ - ມັນໃຊ້ເວລາ
ຄໍາເຫັນພິເສດຈາກຫນ້າທີ່ນັ້ນແລະຈັດການໃຫ້ເຂົາເຈົ້າພິເສດ, ໃສ່ພວກມັນເປັນ
ພາກສ່ວນໃນຕອນທ້າຍຂອງບົດທໍາອິດຂອງເອກະສານ (ມັນສ້າງບົດທໍາອິດຖ້າ
ຈໍາເປັນ).
ທາງເລືອກໃນການ ໄດ້ຖືກອະທິບາຍຢູ່ໃນພາກ Arguments ແລະ ຄ່າເລີ່ມຕົ້ນ ຂ້າງລຸ່ມນີ້.
ພິເສດ ມາກUP
ມີບາງກໍລະນີທີ່ມີການປຸງແຕ່ງພິເສດພິເສດແມ່ນປະຕິບັດ, ສ່ວນຫຼາຍແມ່ນຢູ່ໃນ
ຄໍາຄິດຄໍາເຫັນທໍາອິດທີ່ພົບເຫັນຢູ່ໃນໄຟລ໌ແຫຼ່ງ, ຈາກທີ່ chunks ຕ່າງໆຂອງ GSDoc markup ອາດຈະເປັນ
ສະກັດແລະວາງເຂົ້າໄປໃນສະຖານທີ່ທີ່ເຫມາະສົມໃນເອກະສານຜົນຜະລິດ -
ແຫຼ່ງ Autogsdoc:
ໃນເສັ້ນໃດບ່ອນໃດ ແຫຼ່ງ Autogsdoc: ໄດ້ຖືກພົບເຫັນ, ສ່ວນທີ່ເຫຼືອຂອງເສັ້ນໄດ້ຖືກປະຕິບັດເປັນ
ຊື່ໄຟລ໌ແຫຼ່ງທີ່ຈະໃຊ້ແທນການສົມມຸດຕິຖານວ່າແຕ່ລະໄຟລ໌ .h
ປະມວນຜົນແລ້ວໃຊ້ໄຟລ໌ .m ທີ່ມີຊື່ດຽວກັນ. ທ່ານອາດຈະສະຫນອງຫຼາຍ ແຫຼ່ງ Autogsdoc:
ແຖວທີ່ໄຟລ໌ header ປະກາດລາຍການທີ່ຖືກກໍານົດໄວ້ໃນຫຼາຍແຫຼ່ງໄຟລ໌.
ຖ້າຊື່ໄຟລ໌ແມ່ນສົມບູນ, ມັນຖືກນໍາໃຊ້ຄືກັນກັບທີ່ສະຫນອງໃຫ້. ຖ້າໃນອີກດ້ານຫນຶ່ງ, ມັນເປັນ
ເສັ້ນທາງທີ່ກ່ຽວຂ້ອງ, ຊອບແວຊອກຫາໄຟລ໌ແຫຼ່ງທໍາອິດທີ່ກ່ຽວຂ້ອງກັບສະຖານທີ່
ຂອງໄຟລ໌ header, ແລະຖ້າບໍ່ພົບຢູ່ທີ່ນັ້ນ, ກ່ຽວຂ້ອງກັບໄດເລກະທໍລີປະຈຸບັນໃນນັ້ນ
autogsdoc ກໍາລັງແລ່ນ, ແລະສຸດທ້າຍກ່ຽວຂ້ອງກັບໄດເລກະທໍລີທີ່ລະບຸໄວ້ໂດຍ
DocumentationDirectory Default
ບົດຄັດຫຍໍ້ຂອງເນື້ອໃນຂອງເອກະສານ ... ວາງໄວ້ໃນຫົວຂອງຜົນຜະລິດ GSDoc.
ລາຍລະອຽດຂອງຜູ້ຂຽນລະຫັດ - ອາດຈະໄດ້ຮັບການຊ້ໍາເພື່ອຈັດການກໍລະນີທີ່ a
ເອກະສານມີຜູ້ຂຽນຫຼາຍ. ວາງຢູ່ໃນຫົວຂອງຜົນຜະລິດ GSDoc. ເປັນການຊ່ວຍເຫຼືອ
readability ຂອງແຫຼ່ງ, ບາງການປຸງແຕ່ງເພີ່ມເຕີມພິເສດແມ່ນປະຕິບັດທີ່ກ່ຽວຂ້ອງກັບ
ຜູ້ຂຽນເອກະສານ - ແຖວໃດນຶ່ງຂອງແບບຟອມ 'ຜູ້ຂຽນ: ຊື່ ', ຫຼື 'ໂດຍ:
ຊື່ ', ຫຼື 'ຜູ້ຂຽນ: ຊື່' ຫຼື 'ໂດຍ: ຊື່' ຈະຖືກຮັບຮູ້ ແລະ
ປ່ຽນເປັນ ຜູ້ປະພັນ ອົງປະກອບ, ອາດຈະປະກອບດ້ວຍ an ອີເມວ ອົງປະກອບ.
ວາງໄວ້ໃນຜົນຜະລິດ GSDoc ກ່ອນການສິ້ນສຸດຂອງຮ່າງກາຍຂອງເອກະສານ - ຈຸດປະສົງ
ເພື່ອໃຊ້ສໍາລັບເອກະສານຊ້ອນທ້າຍ, ດັດສະນີແລະອື່ນໆ.
ວາງໄວ້ທັນທີກ່ອນທີ່ຈະສ້າງເອກະສານຫ້ອງຮຽນໃດໆ ... ມີຈຸດປະສົງທີ່ຈະນໍາໃຊ້
ເພື່ອໃຫ້ລາຍລະອຽດໂດຍລວມກ່ຽວກັບວິທີທີ່ລະຫັດທີ່ຖືກບັນທຶກເຮັດວຽກ. ໃດ
ເອ ກະ ສານ ສໍາ ລັບ ການ ທໍາ ງານ ຕົ້ນ ຕໍ () ຂອງ ໂຄງ ການ ແມ່ນ inserted ເປັນ ພາກ ສ່ວນ ໃນ ຕອນ ທ້າຍ
ຂອງບົດນີ້.
ລິຂະສິດຂອງເນື້ອໃນຂອງເອກະສານ ... ວາງຢູ່ໃນຫົວຂອງຜົນຜະລິດ GSDoc.
ເປັນການຊ່ວຍໃນການອ່ານແຫຼ່ງທີ່ມາ, ບາງການປຸງແຕ່ງເພີ່ມເຕີມພິເສດແມ່ນ
ປະຕິບັດ - ແຖວໃດນຶ່ງຂອງແບບຟອມ 'ລິຂະສິດ (C) text' ຈະຖືກຮັບຮູ້ ແລະປ່ຽນ
to a ຄັດລອກ ອົງປະກອບ.
ວັນທີຂອງການແກ້ໄຂເອກະສານ ... ວາງໄວ້ໃນຫົວຂອງຜົນຜະລິດ GSDoc. ຖ້າ
ອັນນີ້ຖືກລະເວັ້ນ ເຄື່ອງມືຈະພະຍາຍາມສ້າງຄ່າຈາກແທັບ RCS Date (ຖ້າ
ມີ).
ແຊກເຂົ້າໄປໃນເອກະສານໃນຕອນເລີ່ມຕົ້ນຂອງຮ່າງກາຍ ... ມີຈຸດປະສົງເພື່ອສະຫນອງການ
ການແນະນຳ ຫຼືໜ້າເນື້ອຫາ ແລະ ອື່ນໆ.
ຫົວຂໍ້ຂອງເອກະສານ ... ວາງໄວ້ໃນຫົວຂອງຜົນຜະລິດ GSDoc. ຖ້ານີ້ຖືກລະເວັ້ນ
ເຄື່ອງມືຈະສ້າງຫົວຂໍ້ (ອາດຈະທຸກຍາກ) ຂອງຕົນເອງ - ດັ່ງນັ້ນທ່ານຄວນລວມເອົາອັນນີ້
markup ດ້ວຍຕົນເອງ.
ຕົວລະບຸເວີຊັນຂອງເອກະສານ ... ວາງໄວ້ໃນຫົວຂອງຜົນຜະລິດ GSDoc. ຖ້າ
ອັນນີ້ຖືກລະເວັ້ນ, ເຄື່ອງມືຈະພະຍາຍາມສ້າງຄ່າຈາກແທັບ RCS Revision (ຖ້າ
ມີ).
NB ເຄື່ອງຫມາຍການອະທິບາຍພຽງແຕ່ອາດຈະຖືກນໍາໃຊ້ໃນຫ້ອງຮຽນ, ປະເພດ, ຫຼືເອກະສານອະນຸສັນຍາ
... ຖ້າເປັນດັ່ງນັ້ນ, ມັນໄດ້ຖືກສະກັດແລະຫໍ່ຮອບສ່ວນທີ່ເຫຼືອຂອງເອກະສານສໍາລັບຫ້ອງຮຽນ
ເປັນບົດຂອງຫ້ອງຮຽນ. ສ່ວນທີ່ເຫລືອຂອງເອກະສານຊັ້ນຮຽນແມ່ນໃສ່ຕາມປົກກະຕິຢູ່ທີ່
ໃນຕອນທ້າຍຂອງບົດ, ແຕ່ອາດຈະຖືກແທນທີ່ແທນທີ່ຈະເປັນ pseudo-
ອົງປະກອບພາຍໃນ ອົງປະກອບ.
ວິທີການ ມາກUP
ໃນຄໍາເຫັນຖືກນໍາໃຊ້ເພື່ອສະຫນອງຂໍ້ຄວາມສໍາລັບຄໍາອະທິບາຍວິທີການ, markup ຕໍ່ໄປນີ້ແມ່ນ
ເອົາອອກຈາກຂໍ້ຄວາມແລະຈັດການໂດຍສະເພາະ -
ວິທີການໄດ້ຖືກຫມາຍວ່າເປັນຕົວກໍານົດເບື້ອງຕົ້ນສໍາລັບຊັ້ນຮຽນ.
ວິທີການຖືກໝາຍວ່າເປັນອັນໜຶ່ງທີ່ subclass ຈະຕ້ອງ override (ເຊັ່ນ: abstract
ວິທີການ).
ວິທີການໄດ້ຖືກຫມາຍວ່າເປັນຫນຶ່ງທີ່ subclass ຄວນ ບໍ່ ລົບລ້າງ.
ເຄື່ອງຫມາຍຖືກໂຍກຍ້າຍອອກຈາກຄໍາອະທິບາຍແລະວາງໄວ້ ຫຼັງຈາກ ມັນຢູ່ໃນຜົນຜະລິດ GSDoc -
ດັ່ງນັ້ນວິທີການໄດ້ຖືກອະທິບາຍວ່າສອດຄ່ອງກັບ (ຫຼືບໍ່ສອດຄ່ອງກັບ) ທີ່ກໍານົດໄວ້
ມາດຕະຖານ.
ເຄື່ອງປະດັບ ມາກUP
ໂດຍທົ່ວໄປແລ້ວ, ຂໍ້ຄວາມໃນຄໍາຄິດເຫັນແມ່ນໄດ້ປັບຮູບແບບມາດຕະຖານແລະ indent ມັນງາມ ... ໄດ້
ການປະຕິຮູບແມ່ນ ບໍ່ ປະຕິບັດຢູ່ໃນຂໍ້ຄວາມໃດຫນຶ່ງຢູ່ໃນ ອົງປະກອບ. ໃນເວລາທີ່ຂໍ້ຄວາມແມ່ນ
ໄດ້ຮັບການປະຕິຮູບ, ມັນຖືກແບ່ງອອກເປັນຊ່ອງຫວ່າງທີ່ແຍກອອກຈາກ "ຄໍາສັບຕ່າງໆ" ເຊິ່ງຂຶ້ນກັບ
ການປຸງແຕ່ງພິເສດບາງຢ່າງ ...
ບາງຄ່າຄົງທີ່ທີ່ຮູ້ຈັກກັນດີເຊັ່ນ YES, NO, ແລະ nil ຖືກຫຸ້ມຢູ່ໃນ ...
ເຄື່ອງໝາຍ.
ຊື່ຂອງວິທີການ arguments ພາຍໃນຄໍາອະທິບາຍວິທີການແມ່ນ enclosed ໃນ ...
</ var> ເຄື່ອງໝາຍ.
ຊື່ວິທີການ (ເລີ່ມຕົ້ນດ້ວຍການບວກຫຼືລົບ) ແມ່ນຕິດຢູ່ໃນ ...
ເຄື່ອງໝາຍ. ເຊັ່ນ: "-init" (ໂດຍບໍ່ມີວົງຢືມ) ຈະຖືກຫໍ່ຢູ່ໃນເອກະສານອ້າງອີງ GSDoc
ອົງປະກອບເພື່ອຊີ້ໃຫ້ເຫັນວິທີການ init ຂອງຊັ້ນປະຈຸບັນຫຼື, ຖ້າມີພຽງແຕ່ຫນຶ່ງຊັ້ນທີ່ຮູ້ຈັກ
ມີວິທີການ init, ມັນຈະຫມາຍເຖິງວິທີການຂອງຫ້ອງຮຽນນັ້ນ. ໃຫ້ສັງເກດຄວາມຈິງທີ່ວ່າ
ຊື່ວິທີການຕ້ອງຖືກອ້ອມຮອບດ້ວຍຊ່ອງຫວ່າງເພື່ອຮັບຮູ້ (ເຖິງວ່າໝາຍຈຸດ,
fullstop, ຫຼື semicolon ໃນຕອນທ້າຍຂອງ specifier ຈະປະຕິບັດຄືກັບ whitespace).
ຕົວລະບຸວິທີການລວມທັງຊື່ຫ້ອງຮຽນ (ເລີ່ມຕົ້ນ ແລະລົງທ້າຍດ້ວຍວົງເລັບສີ່ຫຼ່ຽມ)
ຖືກປິດລ້ອມໃນ ... ເຄື່ອງໝາຍ. e.g '[NSObject-init]', ຈະສ້າງເປັນ
ການອ້າງອີງເຖິງວິທີການ init ຂອງ NSObject (ບໍ່ວ່າຈະເປັນຫ້ອງຮຽນທີ່ເຫມາະສົມ, ຫຼືອັນໃດອັນໜຶ່ງຂອງມັນ
categories), ໃນຂະນະທີ່ '[(NSCopying)-copyWithZone:]', ສ້າງການອ້າງອີງເຖິງວິທີການໃນ
ອະນຸສັນຍາ NSCopying. ໃຫ້ສັງເກດວ່າບໍ່ມີຊ່ອງຫວ່າງຕ້ອງປາກົດລະຫວ່າງວົງເລັບສີ່ຫຼ່ຽມ
ໃນຕົວລະບຸເຫຼົ່ານີ້. ຊື່ໂປຣໂຕຄໍຖືກໃສ່ໃນວົງເລັບມົນແທນທີ່ຈະເປັນ
ວົງເລັບມຸມປະເພນີ, ເພາະວ່າ GSDoc ເປັນພາສາ XML, ແລະ XML ປະຕິບັດມຸມ
ວົງເລັບໂດຍສະເພາະ.
ຊື່ຟັງຊັນ (ລົງທ້າຍດ້ວຍ '()') ນອກເໜືອໄປຈາກ 'main()' ແມ່ນຕິດຢູ່ໃນ ...
ເຄື່ອງໝາຍ. ເຊັ່ນ: "NSLogv()" (ໂດຍບໍ່ມີວົງຢືມ) ຈະຖືກຫໍ່ຢູ່ໃນ GSDoc
ອົງປະກອບອ້າງອີງເພື່ອຊີ້ໃຫ້ເຫັນເອກະສານຂອງຟັງຊັນ NSLog. ໃຫ້ສັງເກດຄວາມຈິງ
ວ່າຊື່ຟັງຊັນຈະຕ້ອງຖືກອ້ອມຮອບດ້ວຍຊ່ອງຫວ່າງ (ເຖິງວ່າໝາຍຈຸດ, ຢຸດເຕັມ, ຫຼື
semicolon ໃນຕອນທ້າຍຂອງ specifier ຈະເຮັດຫນ້າທີ່ເປັນ whitespace terminator).
ການໂຕ້ຖຽງ ແລະ ຄ່າເລີ່ມຕົ້ນ
ເຄື່ອງມືຍອມຮັບຄ່າເລີ່ມຕົ້ນຂອງຜູ້ໃຊ້ທີ່ແນ່ນອນ (ເຊິ່ງແນ່ນອນວ່າສາມາດສະຫນອງເປັນເສັ້ນຄໍາສັ່ງ
arguments ໂດຍ prepending '-' ກ່ອນຊື່ເລີ່ມຕົ້ນແລະໃຫ້ມູນຄ່າຫຼັງຈາກນັ້ນ, ໃນ
- ທໍາຄວາມສະອາດແມ່ນ:
ທໍາຄວາມສະອາດ
ຖ້າຄ່າ boolean ນີ້ຖືກຕັ້ງເປັນ YES, ຫຼັງຈາກນັ້ນແທນທີ່ຈະສ້າງເອກະສານ, the
ເຄື່ອງມືລຶບໄຟລ໌ GSDoc ທັງໝົດທີ່ສ້າງຂຶ້ນໃນໂຄງການ, ແລະໄຟລ໌ html ທັງໝົດທີ່ສ້າງຂຶ້ນ
ຈາກພວກມັນ (ເຊັ່ນດຽວກັນກັບອັນທີ່ຈະຖືກສ້າງຂື້ນຈາກໄຟລ໌ GSDoc ທີ່ລະບຸໄວ້
ຢ່າງຊັດເຈນ), ແລະສຸດທ້າຍເອົາໄຟລ໌ດັດສະນີໂຄງການ. ຂໍ້ຍົກເວັ້ນພຽງແຕ່ນີ້
ແມ່ນໄຟລ໌ GSDoc ທີ່ເປັນແມ່ແບບ (ເຊັ່ນນັ້ນທີ່ລະບຸໄວ້ໂດຍໃຊ້ "-ConstantTemplate ... ",
"-FunctionsTemplate ... " arguments ແລະອື່ນໆ) ບໍ່ໄດ້ຖືກລຶບລ້າງເວັ້ນເສຍແຕ່ວ່າ CleanTemplates
ທຸງຖືກຕັ້ງ.
CleanTemplates
ທຸງນີ້ກໍານົດວ່າໄຟລ໌ GSDoc ແມ່ແບບຈະຖືກລຶບອອກພ້ອມກັບໄຟລ໌ອື່ນໆ
ໄຟລ໌ເມື່ອເລືອກທີ່ສະອາດຖືກລະບຸ. ຄ່າເລີ່ມຕົ້ນແມ່ນສໍາລັບພວກເຂົາທີ່ຈະບໍ່ຖືກໂຍກຍ້າຍ
... ນັບຕັ້ງແຕ່ແມ່ແບບເຫຼົ່ານີ້ອາດຈະຖືກຜະລິດດ້ວຍຕົນເອງແລະພຽງແຕ່ມີຂໍ້ມູນໃສ່
ເຂົ້າໄປໃນພວກເຂົາ.
ຕົວແບບຄົງທີ່
ລະບຸຊື່ຂອງເອກະສານແມ່ແບບໃນເອກະສານທີ່ກ່ຽວກັບຄ່າຄົງທີ່
ຄວນຖືກໃສ່ຈາກໄຟລ໌ທັງຫມົດໃນໂຄງການ. ນີ້ແມ່ນເປັນປະໂຫຍດຖ້າຫາກວ່າຄົງທີ່ຢູ່ໃນ
ລະຫັດແຫຼ່ງແມ່ນກະແຈກກະຈາຍໄປທົ່ວຫຼາຍໄຟລ໌, ແລະທ່ານຕ້ອງການຈັດກຸ່ມພວກມັນເປັນອັນດຽວ
ສະຖານທີ່. ທ່ານມີຄວາມຮັບຜິດຊອບສໍາລັບການຮັບປະກັນວ່າເອກະສານແມ່ແບບພື້ນຖານ (ໃນທີ່
ເອກະສານຄົງທີ່ສ່ວນບຸກຄົນຖືກໃສ່) ມີຂໍ້ມູນອື່ນໆທັງຫມົດທີ່ທ່ານ
ຕ້ອງການ, ແຕ່ເປັນ autogsdoc ສະດວກສະບາຍຈະສ້າງແບບງ່າຍດາຍ (ທີ່ທ່ານອາດຈະ
ຫຼັງຈາກນັ້ນແກ້ໄຂ) ສໍາລັບທ່ານຖ້າຫາກວ່າໄຟລ໌ບໍ່ມີ. ການແຊກຊຶມເກີດຂຶ້ນທັນທີ
ກ່ອນທີ່ຈະໄດ້ ກັບຄືນໄປບ່ອນ ອົງປະກອບ (ຫຼືຖ້າບໍ່ມີ, ທັນທີກ່ອນທີ່ຈະສິ້ນສຸດ
ຮ່າງກາຍ ອົງປະກອບ) ໃນແມ່ແບບ.
ປະກາດ
ລະບຸບ່ອນທີ່ສ່ວນຫົວຈະຖືກບັນທຶກເປັນທີ່ພົບເຫັນ. ຊື່ທີ່ແທ້ຈິງທີ່ຜະລິດ
ໃນເອກະສານແມ່ນສ້າງຂື້ນໂດຍການຕື່ມອົງປະກອບສຸດທ້າຍຂອງຊື່ໄຟລ໌ header
ກັບຄ່າຂອງຄ່າເລີ່ມຕົ້ນນີ້. ຖ້າຄ່າເລີ່ມຕົ້ນນີ້ບໍ່ໄດ້ຖືກລະບຸ, ຊື່ເຕັມຂອງ
ໄຟລ໌ header (ຕາມທີ່ສະຫນອງໃຫ້ຢູ່ໃນເສັ້ນຄໍາສັ່ງ), ກັບ HeaderDirectory ເລີ່ມຕົ້ນ
prepended, ຖືກນໍາໃຊ້. ການນໍາໃຊ້ປົກກະຕິຂອງການນີ້ອາດຈະເປັນ '"-Declared Foundation"' ໃນເວລາທີ່
ການສ້າງເອກະສານສໍາລັບຫ້ອງສະຫມຸດພື້ນຖານ GNUstep. ນີ້ຈະສົ່ງຜົນໃຫ້
ເອກະສານທີ່ບອກວ່າ NSString ຖືກປະກາດໃນ 'Foundation/NSString.h'
DocumentAllInstanceVariables
ທຸງນີ້ອະນຸຍາດໃຫ້ທ່ານສ້າງເອກະສານສໍາລັບຕົວແປຕົວຢ່າງທັງຫມົດ. ປົກກະຕິ,
ສະເພາະທີ່ປະກາດຢ່າງຈະແຈ້ງ 'ສາທາລະນະ' ຫຼື 'ປົກປ້ອງ' ຈະຖືກບັນທຶກໄວ້.
DocumentInstanceVariables
ທຸງນີ້ອະນຸຍາດໃຫ້ທ່ານປິດເອກະສານສໍາລັບຕົວແປຕົວຢ່າງຢ່າງສົມບູນ.
ໂດຍປົກກະຕິ, ຕົວແປຕົວຢ່າງ 'ສາທາລະນະ' ຫຼື 'ປ້ອງກັນ' ທີ່ຖືກປະກາດຢ່າງຈະແຈ້ງຈະເປັນ.
documented.
InstanceVariablesAtEnd
ທຸງນີ້, ຖ້າຕັ້ງ, ຊີ້ໄປຫາເຄື່ອງສ້າງ HTML ເພື່ອວາງເອກະສານຕົວແປຕົວຢ່າງ
ໃນຕອນທ້າຍຂອງຫ້ອງຮຽນ, ແທນທີ່ຈະເລີ່ມຕົ້ນ. ນີ້ແມ່ນເປັນປະໂຫຍດຖ້າທ່ານໃຊ້ຫຼາຍ
ຕົວແປຕົວຢ່າງທີ່ຖືກປົກປ້ອງເຊິ່ງພຽງແຕ່ຈະມີຄວາມສົນໃຈອັນດັບສອງເທົ່ານັ້ນ
ຜູ້ໃຊ້ທົ່ວໄປຂອງຫ້ອງຮຽນ.
DocumentationDirectory
ອາດຈະຖືກນໍາໃຊ້ເພື່ອລະບຸໄດເລກະທໍລີທີ່ເອກະສານທີ່ສ້າງຂຶ້ນຈະຖືກວາງໄວ້.
ຖ້າອັນນີ້ບໍ່ໄດ້ຕັ້ງ, ຜົນຜະລິດຈະຖືກວາງໄວ້ໃນໄດເລກະທໍລີປະຈຸບັນ. ໄດເລກະທໍລີນີ້ຄືກັນ
ໃຊ້ເປັນທາງເລືອກສຸດທ້າຍເພື່ອຊອກຫາໄຟລ໌ແຫຼ່ງ (ບໍ່ແມ່ນສ່ວນຫົວ), ແລະສໍາຄັນກວ່ານັ້ນ, ມັນ
ຖືກນໍາໃຊ້ເປັນ ຄັ້ງທໍາອິດ ແລະ ພຽງແຕ່ ຣີສອດເພື່ອຊອກຫາໄຟລ໌ .gsdoc ໃດໆກໍຕາມທີ່ສົ່ງຜ່ານ
ເສັ້ນຄໍາສັ່ງ. ຂໍ້ມູນເສັ້ນທາງໃດກໍໄດ້ໃຫ້ສໍາລັບໄຟລ໌ເຫຼົ່ານີ້ແມ່ນ ລົບອອກ ແລະພວກເຂົາແມ່ນ
ຄົ້ນຫາຢູ່ໃນ 'DocumentationDirectory' (ເຖິງແມ່ນວ່າພວກເຂົາອາດຈະບໍ່ມີ
autogenerated).
ໄຟ
ລະບຸຊື່ຂອງໄຟລ໌ທີ່ມີບັນຊີລາຍຊື່ຂອງຊື່ໄຟລ໌ເປັນ array ບັນຊີລາຍຊື່ຊັບສິນ
(ຊື່1,ຊື່2,...) ຮູບແບບ. ຖ້າມີອັນນີ້, ຊື່ໄຟລ໌ໃນລາຍການ argument ຂອງໂຄງການ
ຖືກລະເລີຍ ແລະຊື່ໃນໄຟລ໌ນີ້ຖືກໃຊ້ເປັນລາຍການຊື່ເພື່ອປະມວນຜົນ.
ແມ່ແບບຟັງຊັນ
ລະບຸຊື່ຂອງເອກະສານແມ່ແບບໃນເອກະສານທີ່ກ່ຽວກັບຫນ້າທີ່
ຄວນຖືກໃສ່ຈາກໄຟລ໌ທັງຫມົດໃນໂຄງການ. ນີ້ແມ່ນເປັນປະໂຫຍດຖ້າແຫຼ່ງຟັງຊັນ
ລະຫັດແມ່ນກະແຈກກະຈາຍປະມານຫຼາຍໄຟລ໌, ແລະທ່ານຈໍາເປັນຕ້ອງຈັດກຸ່ມມັນເປັນບ່ອນດຽວ. ເຈົ້າແມ່ນ
ຮັບຜິດຊອບສໍາລັບການຮັບປະກັນວ່າເອກະສານແມ່ແບບພື້ນຖານ (ໃນທີ່ບຸກຄົນ
ເອກະສານຟັງຊັນຖືກໃສ່) ມີຂໍ້ມູນອື່ນໆທັງຫມົດທີ່ທ່ານຕ້ອງການ, ແຕ່
ເປັນ autogsdoc ທີ່ສະດວກສະບາຍຈະສ້າງແມ່ແບບງ່າຍໆ (ເຊິ່ງຫຼັງຈາກນັ້ນທ່ານສາມາດແກ້ໄຂໄດ້)
ສໍາລັບທ່ານຖ້າໄຟລ໌ບໍ່ມີຢູ່. ການແຊກຊຶມເກີດຂຶ້ນທັນທີກ່ອນທີ່ຈະ ກັບຄືນໄປບ່ອນ
ອົງປະກອບ (ຫຼືຖ້າບໍ່ມີ, ທັນທີກ່ອນທີ່ຈະສິ້ນສຸດ ຮ່າງກາຍ ອົງປະກອບ) ໃນ
ແມ່ແບບ.
ສ້າງHtml
ອາດຈະຖືກນໍາໃຊ້ເພື່ອກໍານົດວ່າຜົນຜະລິດ HTML ແມ່ນຈະຖືກສ້າງຂຶ້ນ. ຄ່າເລີ່ມຕົ້ນແມ່ນ YES.
HeaderDirectory
ອາດຈະຖືກນໍາໃຊ້ເພື່ອລະບຸໄດເລກະທໍລີທີ່ຈະຊອກຫາໄຟລ໌ header. ເມື່ອສະໜອງໃຫ້,
ຄ່ານີ້ແມ່ນຂຶ້ນກັບຊື່ສ່ວນຫົວທີ່ກ່ຽວຂ້ອງ, ຖ້າບໍ່ດັ່ງນັ້ນຊື່ສ່ວນຫົວທີ່ກ່ຽວຂ້ອງ
ຖືກຕີຄວາມ ໝາຍ ທຽບກັບໄດເລກະທໍລີປະຈຸບັນ. ໄຟລ໌ສ່ວນຫົວລະບຸເປັນຢ່າງແທ້ຈິງ
ເສັ້ນທາງບໍ່ໄດ້ຮັບອິດທິພົນໂດຍຄ່າເລີ່ມຕົ້ນນີ້.
IgnoreDependencies
ຄ່າ boolean ທີ່ອາດຈະຖືກໃຊ້ເພື່ອລະບຸວ່າໂປຣແກຣມບໍ່ຄວນສົນໃຈໄຟລ໌
ເວລາການດັດແກ້ ແລະສ້າງໄຟລ໌ຄືນໃໝ່. ສະຫນອງໃຫ້ສໍາລັບການນໍາໃຊ້ສົມທົບກັບ
ລະບົບ 'ເຮັດ', ເຊິ່ງຄາດວ່າຈະຈັດການການກວດສອບການເພິ່ງພາອາໄສຂອງມັນເອງ.
ໂຄງການທ້ອງຖິ່ນ
ມູນຄ່ານີ້ຖືກນໍາໃຊ້ເພື່ອຄວບຄຸມການລວມອັດຕະໂນມັດຂອງໂຄງການພາຍນອກທ້ອງຖິ່ນເຂົ້າໄປໃນ
ລະບົບການດັດແກ້ສໍາລັບການຜະລິດຂອງການອ້າງອີງຂ້າມໃນການຜະລິດເອກະສານສຸດທ້າຍ. ຖ້າ
ຕັ້ງຄ່າເປັນ 'ບໍ່ມີ', ຫຼັງຈາກນັ້ນບໍ່ມີການອ້າງອີງໂຄງການທ້ອງຖິ່ນແມ່ນເຮັດ, ຖ້າບໍ່ດັ່ງນັ້ນ, 'ທ້ອງຖິ່ນ'
ໄດເລກະທໍລີເອກະສານ GNUstep ຖືກຄົ້ນຫາຄືນສໍາລັບໄຟລ໌ທີ່ມີ '.igsdoc'
extension, ແລະຂໍ້ມູນດັດສະນີຈາກໄຟລ໌ເຫຼົ່ານັ້ນຖືກນໍາໃຊ້. ມູນຄ່າຂອງສິ່ງນີ້
string ຍັງຖືກໃຊ້ເພື່ອສ້າງຊື່ໄຟລ໌ໃນການອ້າງອີງຂ້າມ ... ຖ້າມັນເປັນ
string ຫວ່າງເປົ່າ, ເສັ້ນທາງທີ່ຈະໃຊ້ແມ່ນສົມມຸດວ່າເປັນໄຟລ໌ທີ່ຢູ່ໃນໄດເລກະທໍລີດຽວກັນບ່ອນທີ່
ໄຟລ໌ igsdoc ຖືກພົບເຫັນ, ຖ້າບໍ່ດັ່ງນັ້ນມັນຖືກນໍາໃຊ້ເປັນຄໍານໍາຫນ້າຂອງຊື່ໃນດັດຊະນີ. NB.
ໂຄງການທ້ອງຖິ່ນທີ່ມີຊື່ດຽວກັນກັບໂຄງການທີ່ໄດ້ຖືກບັນທຶກໄວ້ໃນປັດຈຸບັນຈະ ບໍ່
ຖືກລວມເຂົ້າໂດຍກົນໄກນີ້. ຖ້າທ່ານຕ້ອງການລວມເອົາໂຄງການດັ່ງກ່າວ, ທ່ານຕ້ອງເຮັດແນວນັ້ນ
ການນໍາໃຊ້ຢ່າງຊັດເຈນ - ໂຄງການ ...
ແມ່ແບບ Macros
ລະບຸຊື່ຂອງເອກະສານແມ່ແບບທີ່ເອກະສານກ່ຽວກັບ macros ຄວນ
ຈະຖືກໃສ່ຈາກໄຟລ໌ທັງຫມົດໃນໂຄງການ. ນີ້ເປັນປະໂຫຍດຖ້າລະຫັດມະຫາພາກຖືກກະແຈກກະຈາຍ
ປະມານໄຟລ໌ຈໍານວນຫຼາຍ, ແລະທ່ານຕ້ອງການຈັດກຸ່ມມັນເຂົ້າໄປໃນບ່ອນດຽວ. ທ່ານຮັບຜິດຊອບ
ໃຫ້ແນ່ໃຈວ່າເອກະສານແມ່ແບບພື້ນຖານ (ເຂົ້າໄປໃນເອກະສານມະຫາພາກສ່ວນບຸກຄົນ
ແມ່ນ inserted) ມີຂໍ້ມູນອື່ນໆທັງຫມົດທີ່ທ່ານຕ້ອງການ, ແຕ່ເປັນການສະດວກ
autogsdoc ຈະສ້າງແມ່ແບບງ່າຍໆ (ເຊິ່ງຫຼັງຈາກນັ້ນທ່ານສາມາດແກ້ໄຂ) ສໍາລັບທ່ານຖ້າ
ບໍ່ມີໄຟລ໌. ການແຊກຊຶມເກີດຂຶ້ນທັນທີກ່ອນທີ່ຈະ ກັບຄືນໄປບ່ອນ ອົງປະກອບ (ຫຼືຖ້າ
ທີ່ບໍ່ມີຢູ່, ທັນທີກ່ອນທີ່ຈະສິ້ນສຸດຂອງ ຮ່າງກາຍ
ອົງປະກອບ) ໃນແມ່ແບບ.
MakeDependencies
ຊື່ໄຟລ໌ທີ່ຈະໃຊ້ເພື່ອອອກຂໍ້ມູນການເພິ່ງພາອາໄສສໍາລັບການສ້າງ. ນີ້ຈະໃຊ້ເວລາ
ຮູບແບບຂອງການລາຍຊື່ໄຟລ໌ header ແລະແຫຼ່ງທັງຫມົດທີ່ຮູ້ຈັກສໍາລັບໂຄງການເປັນການຂຶ້ນກັບຂອງ
ຊື່ໂຄງການ (ເບິ່ງ 'ໂຄງການ').
ໂຄງການ
ອາດຈະຖືກນໍາໃຊ້ເພື່ອລະບຸຊື່ຂອງໂຄງການນີ້ ... ກໍານົດຊື່ຂອງດັດສະນີ
ເອກະສານອ້າງອີງທີ່ຜະລິດເປັນສ່ວນຫນຶ່ງຂອງເອກະສານເພື່ອສະຫນອງຂໍ້ມູນຂ່າວສານທີ່ເຮັດໃຫ້
ໂຄງການອື່ນໆທີ່ຈະອ້າງອີງເຖິງລາຍການໃນໂຄງການນີ້.
ໂຄງການ
ຄ່ານີ້ອາດຈະຖືກສະໜອງເປັນວັດຈະນານຸກົມທີ່ມີເສັ້ນທາງໄປຫາ igsdoc
ໄຟລ໌ດັດສະນີ/ເອກະສານອ້າງອີງທີ່ໃຊ້ໂດຍໂຄງການພາຍນອກ, ພ້ອມກັບຄ່າທີ່ຈະໃຊ້ໃນແຜນທີ່
ຊື່ໄຟລ໌ທີ່ພົບເຫັນຢູ່ໃນດັດຊະນີ. ຕົວຢ່າງ, ຖ້າໄຟລ໌ດັດສະນີໂຄງການ (igsdoc).
ເວົ້າວ່າຫ້ອງຮຽນ 'Foo' ຖືກພົບເຫັນຢູ່ໃນໄຟລ໌ 'Foo', ແລະເສັ້ນທາງທີ່ກ່ຽວຂ້ອງກັບ
ດັດຊະນີໂຄງການນັ້ນແມ່ນ '/usr/share/doc/proj', ຫຼັງຈາກນັ້ນຜົນຜະລິດ html ທີ່ສ້າງຂຶ້ນອາດຈະອ້າງອີງ
ຫ້ອງຮຽນເປັນ '/usr/share/doc/prj/Foo.html' . ໃຫ້ສັງເກດວ່າວັດຈະນານຸກົມອາດຈະເປັນ
ມອບໃຫ້ຢູ່ໃນເສັ້ນຄໍາສັ່ງໂດຍໃຊ້ຮູບແບບ PropertyList ມາດຕະຖານ (ບໍ່ແມ່ນ XML
ຮູບແບບຂອງ OS X), ການນໍາໃຊ້ semicolons ເປັນ line-separators, ແລະ enclosing ມັນເປັນດຽວ
ວົງຢືມ.
ສະແດງໃຫ້ເຫັນຄວາມເພິ່ງພາອາໄສ
ຄ່າ boolean ທີ່ອາດຈະຖືກໃຊ້ເພື່ອລະບຸວ່າໂປຣແກຣມຄວນບັນທຶກໄຟລ໌ໃດ
ກໍາລັງຖືກສ້າງໃຫມ່ເນື່ອງຈາກການຂຶ້ນກັບໄຟລ໌ອື່ນໆ.
ມາດຕະຖານ
ຄ່າ boolean ທີ່ໃຊ້ເພື່ອກໍານົດວ່າໂຄງການຄວນຈະໃສ່ຂໍ້ມູນກ່ຽວກັບ
ການປະຕິບັດຕາມມາດຕະຖານໃນເອກະສານ. ນີ້ຄວນຈະຖືກນໍາໃຊ້ພຽງແຕ່ເມື່ອ
ບັນທຶກຫ້ອງສະຫມຸດ GNUstep ແລະເຄື່ອງມືດ້ວຍຕົນເອງຍ້ອນວ່າມັນສົມມຸດວ່າລະຫັດ
ເອກະສານແມ່ນສ່ວນຫນຶ່ງຂອງ GNUstep ແລະອາດຈະປະຕິບັດຕາມມາດຕະຖານ OpenStep
ຫຼືປະຕິບັດວິທີການເຂົ້າກັນໄດ້ຂອງ MacOS-X.
ໂຄງການລະບົບ
ມູນຄ່ານີ້ຖືກນໍາໃຊ້ເພື່ອຄວບຄຸມການລວມອັດຕະໂນມັດຂອງໂຄງການພາຍນອກລະບົບເຂົ້າໄປໃນ
ລະບົບການດັດແກ້ສໍາລັບການຜະລິດຂອງການອ້າງອີງຂ້າມໃນການຜະລິດເອກະສານສຸດທ້າຍ. ຖ້າ
ຕັ້ງຄ່າເປັນ 'ບໍ່ມີ', ຫຼັງຈາກນັ້ນບໍ່ມີການອ້າງອີງໂຄງການລະບົບແມ່ນເຮັດ, ຖ້າບໍ່ດັ່ງນັ້ນ, 'ລະບົບ'
ໄດເລກະທໍລີເອກະສານ GNUstep ຖືກຄົ້ນຫາຄືນສໍາລັບໄຟລ໌ທີ່ມີ '.igsdoc'
extension, ແລະຂໍ້ມູນດັດສະນີຈາກໄຟລ໌ເຫຼົ່ານັ້ນຖືກນໍາໃຊ້. ມູນຄ່າຂອງສິ່ງນີ້
string ຍັງຖືກໃຊ້ເພື່ອສ້າງຊື່ໄຟລ໌ໃນການອ້າງອີງຂ້າມ ... ຖ້າມັນເປັນ
string ຫວ່າງເປົ່າ, ເສັ້ນທາງທີ່ຈະໃຊ້ແມ່ນສົມມຸດວ່າເປັນໄຟລ໌ທີ່ຢູ່ໃນໄດເລກະທໍລີດຽວກັນບ່ອນທີ່
ໄຟລ໌ igsdoc ຖືກພົບເຫັນ, ຖ້າບໍ່ດັ່ງນັ້ນມັນຖືກນໍາໃຊ້ເປັນຄໍານໍາຫນ້າຂອງຊື່ໃນດັດຊະນີ. NB.
ໂຄງການລະບົບທີ່ມີຊື່ດຽວກັນກັບໂຄງການທີ່ກໍາລັງຖືກບັນທຶກໄວ້ຈະ ບໍ່
ຖືກລວມເຂົ້າໂດຍກົນໄກນີ້. ຖ້າທ່ານຕ້ອງການລວມເອົາໂຄງການດັ່ງກ່າວ, ທ່ານຕ້ອງເຮັດແນວນັ້ນ
ການນໍາໃຊ້ຢ່າງຊັດເຈນ - ໂຄງການ ...
TypedefsTemplate
ລະບຸຊື່ຂອງເອກະສານແມ່ແບບທີ່ເອກະສານກ່ຽວກັບ typedefs ຄວນ
ຈະຖືກໃສ່ຈາກໄຟລ໌ທັງຫມົດໃນໂຄງການ. ນີ້ແມ່ນເປັນປະໂຫຍດຖ້າລະຫັດແຫຼ່ງ typedef ແມ່ນ
ກະແຈກກະຈາຍຢູ່ທົ່ວຫຼາຍໄຟລ໌, ແລະທ່ານຕ້ອງການຈັດກຸ່ມມັນເຂົ້າໄປໃນບ່ອນດຽວ. ເຈົ້າແມ່ນ
ຮັບຜິດຊອບສໍາລັບການຮັບປະກັນວ່າເອກະສານແມ່ແບບພື້ນຖານ (ໃນທີ່ບຸກຄົນ
typedef documentation is inserted) ມີຂໍ້ມູນອື່ນໆທັງໝົດທີ່ທ່ານຕ້ອງການ, ແຕ່ເປັນ
autogsdoc ທີ່ສະດວກສະບາຍຈະສ້າງແມ່ແບບງ່າຍໆ (ເຊິ່ງຫຼັງຈາກນັ້ນທ່ານອາດຈະແກ້ໄຂ) ສໍາລັບ
ທ່ານຖ້າຫາກວ່າໄຟລ໌ບໍ່ມີ. ການແຊກຊຶມເກີດຂຶ້ນທັນທີກ່ອນທີ່ຈະ ກັບຄືນໄປບ່ອນ
ອົງປະກອບ (ຫຼືຖ້າບໍ່ມີ, ທັນທີກ່ອນທີ່ຈະສິ້ນສຸດ ຮ່າງກາຍ ອົງປະກອບ) ໃນ
ແມ່ແບບ.
Up ສະຕຣິງທີ່ໃຊ້ເພື່ອສະໜອງຊື່ທີ່ຈະໃຊ້ໃນລິ້ງ 'ຂຶ້ນ' ຈາກ GSDoc ທີ່ສ້າງຂຶ້ນ
ເອກະສານ. ປົກກະຕິແລ້ວນີ້ຄວນຈະເປັນຊື່ຂອງໄຟລ໌ທີ່ມີດັດຊະນີຂອງ
ເນື້ອໃນຂອງໂຄງການ. ຖ້າອັນນີ້ຂາດໄປ ຫຼືຕັ້ງເປັນສະຕຣິງຫວ່າງເປົ່າ, ຈະບໍ່ 'ຂຶ້ນ'
ການເຊື່ອມຕໍ່ຈະຖືກສະຫນອງໃຫ້ຢູ່ໃນເອກະສານ.
ຕົວແປຕົວແປ
ລະບຸຊື່ຂອງເອກະສານແມ່ແບບໃນເອກະສານທີ່ກ່ຽວກັບຕົວແປ
ຄວນຖືກໃສ່ຈາກໄຟລ໌ທັງຫມົດໃນໂຄງການ. ນີ້ແມ່ນເປັນປະໂຫຍດຖ້າແຫຼ່ງການປ່ຽນແປງ
ລະຫັດແມ່ນກະແຈກກະຈາຍປະມານຫຼາຍໄຟລ໌, ແລະທ່ານຈໍາເປັນຕ້ອງຈັດກຸ່ມມັນເປັນບ່ອນດຽວ. ເຈົ້າແມ່ນ
ຮັບຜິດຊອບສໍາລັບການຮັບປະກັນວ່າເອກະສານແມ່ແບບພື້ນຖານ (ໃນທີ່ບຸກຄົນ
ເອກະສານຕົວແປຖືກໃສ່) ມີຂໍ້ມູນອື່ນໆທີ່ເຈົ້າຕ້ອງການ, ແຕ່
ເປັນ autogsdoc ທີ່ສະດວກສະບາຍຈະສ້າງແມ່ແບບງ່າຍໆ (ເຊິ່ງຫຼັງຈາກນັ້ນທ່ານສາມາດແກ້ໄຂໄດ້)
ສໍາລັບທ່ານຖ້າໄຟລ໌ບໍ່ມີຢູ່. ການແຊກຊຶມເກີດຂຶ້ນທັນທີກ່ອນທີ່ຈະ ກັບຄືນໄປບ່ອນ
ອົງປະກອບ (ຫຼືຖ້າບໍ່ມີ, ທັນທີກ່ອນທີ່ຈະສິ້ນສຸດ ຮ່າງກາຍ ອົງປະກອບ) ໃນ
ແມ່ແບບ.
ວາຈາ
boolean ທີ່ໃຊ້ເພື່ອລະບຸວ່າທ່ານຕ້ອງການໃຫ້ຜົນດີບັ໊ກ/ຄຳເຕືອນ verbose ຫຼືບໍ່
ຜະລິດ.
ຄຳ ເຕືອນ
boolean ທີ່ໃຊ້ເພື່ອລະບຸວ່າທ່ານຕ້ອງການຜົນຜະລິດເຕືອນມາດຕະຖານຫຼືບໍ່ (ເຊັ່ນ: ລາຍງານຂອງ
ວິທີການທີ່ບໍ່ມີເອກະສານ) ຜະລິດ.
WordMap
ຄ່ານີ້ແມ່ນວັດຈະນານຸກົມທີ່ໃຊ້ໃນແຜນທີ່ຕົວລະບຸ/ຄໍາທີ່ພົບເຫັນຢູ່ໃນໄຟລ໌ຕົ້ນສະບັບ
ກັບຄໍາສັບຕ່າງໆອື່ນໆ. ໂດຍທົ່ວໄປແລ້ວທ່ານຈະບໍ່ຕ້ອງໃຊ້ມັນ, ແຕ່ບາງຄັ້ງມັນກໍ່ເປັນປະໂຫຍດ
ເພື່ອຫຼີກເວັ້ນການ parser ສັບສົນໂດຍການນໍາໃຊ້ C preprocessor macro. ເຈົ້າສາມາດ
ນິຍາມມະຫາພາກຢ່າງມີປະສິດທິພາບກັບສິ່ງທີ່ສັບສົນໜ້ອຍລົງ. ມູນຄ່າທີ່ທ່ານເຮັດແຜນທີ່
identifier to must be one of - another identifier, An string ເປົ່າ - ຄ່າແມ່ນ
ignored, ສອງ slashes ('//') - ສ່ວນທີ່ເຫຼືອຂອງເສັ້ນຖືກລະເລີຍ. ໃຫ້ສັງເກດວ່າວັດຈະນານຸກົມ
ອາດຈະຖືກມອບໃຫ້ຢູ່ໃນເສັ້ນຄໍາສັ່ງໂດຍໃຊ້ຮູບແບບ PropertyList ມາດຕະຖານ (ບໍ່ແມ່ນ
ຮູບແບບ XML ຂອງ OS X), ການນໍາໃຊ້ semicolons ເປັນ line-separators, ແລະ enclosing ມັນເປັນດຽວ
ວົງຢືມ.
ເອກະສານລະຫວ່າງ LINKAGE
ຄ່າເລີ່ມຕົ້ນ 'Up' ຖືກນໍາໃຊ້ເພື່ອລະບຸຊື່ຂອງເອກະສານທີ່ຄວນຈະຖືກນໍາໃຊ້ເປັນ
ການເຊື່ອມຕໍ່ 'up' ສໍາລັບເອກະສານອື່ນໆທີ່ໃຊ້. ຊື່ນີ້ຕ້ອງບໍ່ມີເສັ້ນທາງ ຫຼືສ່ວນຂະຫຍາຍ.
ໂດຍທົ່ວໄປແລ້ວ, ເອກະສານທີ່ອ້າງອີງໂດຍຄ່າເລີ່ມຕົ້ນນີ້ຄວນຈະເປັນເອກະສານ GSDoc ທີ່ດັດແກ້ດ້ວຍມື
ເຊິ່ງຄວນມີສ່ວນດ້ານ ຫຼັງ ທີ່ມີດັດຊະນີໂຄງການ. ຕົວຢ່າງ
<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 1.0.3//EN"
"http://www.gnustep.org/gsdoc-1_0_3.xml">
ການອ້າງອີງໂຄງການຂອງຂ້ອຍ
ການອ້າງອີງໂຄງການຂອງຂ້ອຍ
ໃຊ້ autogsdoc ອອນໄລນ໌ໂດຍໃຊ້ບໍລິການ onworks.net
