Haddock - ออนไลน์ในคลาวด์

โครงการ:

ชื่อ

Haddock - เครื่องมือเอกสารสำหรับซอร์สโค้ด Haskell ที่มีคำอธิบายประกอบ

เรื่องย่อ

ปลาทะเลชนิดหนึ่ง [ตัวเลือก] ไฟล์...

DESCRIPTION

หน้าคู่มือนี้จัดทำเอกสารโดยสังเขปเกี่ยวกับ ปลาทะเลชนิดหนึ่ง สั่งการ. เอกสารที่กว้างขวางคือ
มีให้ในรูปแบบอื่น ๆ รวมถึง DVI, PostScript และ HTML; ดูด้านล่าง

ไฟล์ เป็นชื่อไฟล์ที่มีโมดูลซอร์สของ Haskell โมดูลทั้งหมดที่ระบุใน
บรรทัดคำสั่งจะถูกประมวลผลร่วมกัน เมื่อโมดูลหนึ่งอ้างถึงเอนทิตีในอีกโมดูลหนึ่ง
กำลังประมวลผลโมดูล เอกสารจะเชื่อมโยงโดยตรงกับเอนทิตีนั้น

เอนทิตีที่ไม่พบ เช่น เนื่องจากอยู่ในโมดูลที่ไม่ได้เป็น
ประมวลผลโดยเป็นส่วนหนึ่งของชุดงานปัจจุบัน จะไม่ถูกไฮเปอร์ลิงก์ในไฟล์ที่สร้างขึ้น
เอกสาร ปลาทะเลชนิดหนึ่ง จะส่งคำเตือนแสดงรายการตัวระบุทั้งหมดที่มันไม่สามารถ
แก้ปัญหา

โมดูลไม่ควรเรียกซ้ำกัน เช่น ปลาทะเลชนิดหนึ่ง ไม่ชอบว่ายน้ำ
แวดวง

OPTIONS

โปรแกรมใช้ไวยากรณ์บรรทัดคำสั่งของ GNU ตามปกติ โดยมีตัวเลือกแบบยาวขึ้นต้นด้วย two
ขีดกลาง (`--'). สรุปตัวเลือกอยู่ด้านล่าง ดูรายละเอียดได้ที่
เอกสารอื่นๆ

-o DIR, --โอดีร์=DIR
ไดเร็กทอรีที่จะใส่ไฟล์เอาต์พุต

-i ไฟล์, --read-อินเตอร์เฟซ=ไฟล์
อ่านอินเทอร์เฟซจาก ไฟล์.

-D ไฟล์, --การถ่ายโอนข้อมูลอินเตอร์เฟซ=ไฟล์
ดัมพ์อินเทอร์เฟซสำหรับโมดูลเหล่านี้ใน ไฟล์.

-l DIR, --lib=DIR
ตำแหน่งของไฟล์เสริมของ Haddock

-h, --html
สร้างเอกสารในรูปแบบ HTML ไฟล์หลายไฟล์จะถูกสร้างขึ้นใน
ไดเร็กทอรีปัจจุบัน (หรือไดเร็กทอรีที่ระบุหาก -o มีตัวเลือก) รวมทั้ง
ต่อไปนี้:

index.html
หน้าระดับบนสุดของเอกสารประกอบ: แสดงรายการโมดูลที่พร้อมใช้งาน โดยใช้
การเยื้องเพื่อแสดงลำดับชั้นหากโมดูลเป็นแบบลำดับชั้น

Haddock.css
สไตล์ชีตที่ใช้โดย HTML ที่สร้างขึ้น อย่าลังเลที่จะปรับเปลี่ยนสิ่งนี้เป็น
เปลี่ยนสีหรือเค้าโครง หรือแม้แต่ระบุสไตล์ชีตของคุณเองโดยใช้
--css ตัวเลือก

โมดูล.html
หน้า HTML สำหรับแต่ละโมดูล

doc-index.html, doc-ดัชนี-XX.html
ดัชนี แบ่งออกเป็นสองส่วน (ฟังก์ชัน/ตัวสร้าง และประเภท/คลาส ตาม
เนมสเปซ Haskell) และแยกตามตัวอักษรเพิ่มเติม

--ฮูเกิล
เอาต์พุตสำหรับ Hoogle

--html-help=รูป
สร้างดัชนีและสารบัญในรูปแบบ mshelp, mshelp2 หรือ devhelp (ด้วย -h)

--source-base=URL
รวมลิงก์ไปยังไฟล์ต้นฉบับในเอกสารที่สร้างขึ้น โดยที่ URL คือ
URL ฐานที่สามารถค้นหาไฟล์ต้นฉบับได้

-s URL --source-โมดูล=URL
รวมลิงก์ไปยังไฟล์ต้นฉบับในเอกสารที่สร้างขึ้น โดยที่ URL คือ a
ลิงก์ซอร์สโค้ดสำหรับแต่ละโมดูล (โดยใช้ %{FILE} หรือ %{MODULE} vars)

--แหล่งที่มา-เอนทิตี=URL
รวมลิงก์ไปยังไฟล์ต้นฉบับในเอกสารที่สร้างขึ้น โดยที่ URL คือ a
ลิงก์ซอร์สโค้ดสำหรับแต่ละเอนทิตี (โดยใช้ %{FILE}, %{MODULE} หรือ %{NAME} vars)

--comments-ฐาน=URL
URL สำหรับลิงก์ความคิดเห็นบนหน้าเนื้อหาและดัชนี

--ความคิดเห็น-module=URL
URL สำหรับลิงก์ความคิดเห็นสำหรับแต่ละโมดูล (โดยใช้ %{MODULE} var)

--ความคิดเห็น-เอนทิตี=URL
URL สำหรับลิงก์ความคิดเห็นสำหรับแต่ละเอนทิตี (โดยใช้ %{FILE}, %{MODULE} หรือ %{NAME}
วาร์)

--css=ไฟล์
ใช้ CSS ไฟล์ แทนที่จะเป็นสไตล์ชีตเริ่มต้นที่มาพร้อมกับ ปลาทะเลชนิดหนึ่ง สำหรับ HTML
เอาท์พุท ควรระบุบางคลาส: ดูสไตล์ชีตเริ่มต้นสำหรับรายละเอียด

-p ไฟล์, --อารัมภบท=ไฟล์
ระบุไฟล์ที่มีข้อความอารัมภบท

-t TITLE, --หัวข้อ=TITLE
ใช้ TITLE เป็นส่วนหัวของหน้าในแต่ละหน้าในเอกสารประกอบ นี่จะ
ปกติจะเป็นชื่อของห้องสมุดที่จัดทำเป็นเอกสาร

ชื่อเรื่องควรเป็นสตริงธรรมดา (โปรดอย่าใช้มาร์กอัป!)

-k ชื่อ, --แพคเกจ=ชื่อ
ระบุชื่อแพ็คเกจ (ไม่บังคับ)

-n, --no-implicit-โหมโรง
อย่าถือว่านำเข้าพรีลูด

-d, --debug
เปิดใช้งานเอาต์พุตการดีบักพิเศษ

-?, --ช่วยด้วย
แสดงความช่วยเหลือ

-V, --รุ่น
เวอร์ชันที่แสดง

-v, --รายละเอียด
การรายงานสถานะอย่างละเอียด

--use-เนื้อหา=URL
ใช้หน้าเนื้อหา HTML ที่สร้างแยกต่างหาก

--gen-เนื้อหา
สร้างเนื้อหา HTML จากอินเทอร์เฟซที่ระบุ

--use-ดัชนี=URL
ใช้ดัชนี HTML ที่สร้างแยกต่างหาก

--gen-ดัชนี
สร้างดัชนี HTML จากอินเทอร์เฟซที่ระบุ

--ignore-ทั้งหมด-exports
ทำตัวราวกับว่าทุกโมดูลมีแอตทริบิวต์ที่ละเว้นการส่งออก

--ซ่อน=โมดูล
ทำตัวเหมือน โมดูล มีแอตทริบิวต์ซ่อน

--use-package=แพคเกจ
โมดูลที่กำลังดำเนินการขึ้นอยู่กับ แพคเกจ.

ใช้แฮดด็อกออนไลน์โดยใช้บริการ onworks.net