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

โครงการ:

ชื่อ

cxref - C เครื่องมืออ้างอิงและเอกสารอ้างอิง

เรื่องย่อ

cxref ชื่อไฟล์ [ ... ชื่อไฟล์] [-โอบอกฉัน] [-NSชื่อฐาน] [-NSชื่อฐาน] [-ทุกความคิดเห็น]
[-ไม่มีความคิดเห็น] [-คำต่อคำ-ความคิดเห็น] [-บล็อก-ความคิดเห็น]
[-xref[-all][-file][-func][-var][-type]] [-เตือน[-ทั้งหมด][-ความคิดเห็น][-xref]]
[-ดัชนี[-ทั้งหมด][-ไฟล์][-func][-var][-ประเภท]] [-ดิบ] [-ลาเท็กซ์] [-html[-src]] [-rtf] [-sgml]
[-ผมบอกฉัน] [-NSกำหนด] [-ยูกำหนด] [-ปชป โปรแกรม cpp_] - cpp_args ... cpp_args]

cxref ชื่อไฟล์ [ ... ชื่อไฟล์] -ลบ [-โอบอกฉัน] [-NSชื่อฐาน] [-NSชื่อฐาน]

DESCRIPTION

โปรแกรมที่สามารถสร้างเอกสารและการอ้างอิงโยงสำหรับ C . ได้โดยอัตโนมัติ
โครงการ

อินพุตคือโปรแกรม C ใดๆ ที่มีความคิดเห็นที่เหมาะสม และผลลัพธ์คือ LaTeX, HTML, RTF หรือ
ไฟล์ SGML

OPTIONS

ชื่อไฟล์
ชื่อของไฟล์ไปยังเอกสาร ไฟล์จำนวนเท่าใดก็ได้ที่จัดทำเป็นเอกสารในแต่ละครั้ง

-ลบ
ไฟล์ที่มีชื่อจะถูกลบออกจากไดเร็กทอรีเอาต์พุตและรายการใน
ฐานข้อมูลอ้างอิงโยงและไฟล์เอาท์พุตหลักจะถูกลบออก

-Odirname
ชื่อของไดเร็กทอรีที่จะใช้สำหรับเอาต์พุตไฟล์ latex และตำแหน่งของ
ไฟล์อ้างอิงโยงที่สร้างขึ้น

-ชื่อเบส
ชื่อที่จะใช้สำหรับส่วนแรกของเอาต์พุตและไฟล์อ้างอิงโยงแทน
ของ cxref นามสกุลไฟล์ยังคงเหมือนเดิม

-ชื่อ
เมื่อไฟล์ต้นฉบับอยู่ในไดเร็กทอรีมากกว่าหนึ่งไดเร็กทอรี ให้ตั้งค่า dirname เป็นชื่อ
ไดเร็กทอรีรากของแผนผังต้นทาง (ใช้พาธสัมพัทธ์ถ้าง่ายกว่า เช่น `-R..-').
จากนั้นจะเรียกใช้ cxref จากไดเร็กทอรีรูทนั้นและ `-Odirname' จะต้องเป็น
สัมพันธ์กับไดเร็กทอรีนั้น

-ทุกความคิดเห็น
ในกรณีที่คุณคิดว่าความคิดเห็นที่มีอยู่อาจใช้งานได้ (ดูคำอธิบายด้านบน
ความเห็นพิเศษ) [อันตราย! ตัวเลือกนี้สามารถสร้างผลลัพธ์ที่แปลกประหลาดได้]

-ไม่มีความคิดเห็น
ละเว้นความคิดเห็นทั้งหมด มีประโยชน์หากคุณต้องการแค่การอ้างอิงโยง ไม่ใช่
เอกสาร

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

-บล็อกความคิดเห็น
เมื่อความคิดเห็นในโปรแกรมถูกจัดรูปแบบในรูปแบบ `บล็อก' (ด้วยการนำหน้า
'*' ในทุกบรรทัด) ตัวเลือกนี้จะลบอักขระนั้นออกจาก
เอาท์พุท [ใช้ได้กับ `*', `+', `|' หรือ `:' ในแต่ละบรรทัด]

-xref สร้างข้อมูลอ้างอิงโยง (ดูด้านล่าง)
-all ทั้งหมดอ้างอิงโยง
-file การอ้างอิงโยงสำหรับไฟล์
-func การอ้างอิงโยงสำหรับฟังก์ชัน
-var การอ้างอิงข้ามสำหรับตัวแปร
-type การอ้างอิงโยงสำหรับประเภท

-เตือน สร้างคำเตือน ตัวเลือกจะต้องต่อกัน:
-all คำเตือนทั้งหมด
-comment เตือนความคิดเห็นที่หายไป
-xref เตือนว่าไม่มีการอ้างอิงโยง

-ดัชนี สร้างดัชนีอ้างอิง ตัวเลือกจะต้องต่อกัน:
-all ดัชนีทั้งหมด
-file ดัชนีของไฟล์
-func ดัชนีของฟังก์ชัน
-var ดัชนีของตัวแปร
-type ดัชนีประเภท

-ดิบ สร้างเอาต์พุตรูปแบบดิบ แทบไม่มีประโยชน์อะไรมาก ยกเว้นด้วย -warn

-ลาเท็กซ์ สร้างไฟล์ LaTeX เพื่อบันทึกไฟล์ต้นฉบับแต่ละไฟล์และไฟล์พิเศษด้วย
ที่รวมแต่ละไฟล์เหล่านี้

-html สร้างไฟล์ HTML 4.01 เพื่อบันทึกไฟล์ต้นฉบับแต่ละไฟล์และไฟล์หลักเป็น
อ้างอิงแต่ละไฟล์เหล่านี้

-html-src
สร้างเอาต์พุต HTML และเวอร์ชัน HTML ของไฟล์ต้นฉบับพร้อมลิงก์

-rtf สร้างไฟล์ Rich Text Format (RTF) เพื่อบันทึกไฟล์ต้นฉบับ

-sgml สร้างไฟล์ SGML เพื่อบันทึกไฟล์ต้นฉบับ (โดยใช้ LinuxDoc DTD)

-ชื่อ
ตัวเลือก GCC เพื่อระบุเส้นทางสำหรับไฟล์รวม

-กำหนด
ตัวเลือก GCC เพื่อกำหนดสัญลักษณ์ตัวประมวลผลล่วงหน้า

-Udefine
ตัวเลือก GCC เพื่อกำหนดสัญลักษณ์ตัวประมวลผลล่วงหน้า

-ปชป โครงการ
ชื่อของโปรแกรมที่จะใช้แทนค่าเริ่มต้นของเวลาคอมไพล์ โปรแกรม
ต้องสามารถดำเนินการทั้งหมดที่ `gcc -E -C -dD' ทำได้จึงจะได้ผล ถ้า
โปรแกรมรับข้อโต้แย้งจากนั้นสิ่งทั้งหมดจะต้องอยู่ในเครื่องหมายคำพูดเพื่อให้มัน
ถูกตีความว่าเป็นอาร์กิวเมนต์เดียวสำหรับ cxref

--หาเรื่อง ... หาเรื่อง
อาร์กิวเมนต์เพิ่มเติมที่จะส่งผ่านไปยังตัวประมวลผลล่วงหน้าสามารถวางไว้หลัง `--'
ตัวคั่น

C ผู้รวบรวม การแทนที่ cxref-ซีซี
เพื่อให้ง่ายขึ้นโดยใช้ cxref บนซอร์สโค้ดที่มีอยู่ ขณะนี้มีเชลล์สคริปต์ที่จะ
เรียกคอมไพเลอร์ C แล้วเรียก cxref เพื่อประมวลผลไฟล์ต้นฉบับ นี่หมายความว่ามัน
สามารถใช้แทน CC ใน Makefiles และสิ่งที่คล้ายกันได้

การใช้งาน: cxref-cc [ตัวเลือก cc ปกติ]

ชื่อของไฟล์ต้นทางถูกแยกจากรายการตัวเลือกเช่นเดียวกับ `-D*'
`-I*', `-U*' ตั้งค่าสถานะและเมื่อคอมไพเลอร์ C ออกจาก cxref สำเร็จจะถูกเรียก NS
ชื่อของคอมไพเลอร์ C ที่จะใช้ถูกควบคุมโดยตัวแปรสภาพแวดล้อม CXREFCC หรือ if
นี้ไม่ได้ตั้งค่าเป็นตัวแปรสภาพแวดล้อม CC หรือล้มเหลวเพียงแค่ gcc

การใช้สคริปต์นี้ต้องใช้ไฟล์การกำหนดค่า `.cxref' เพื่อให้มีตัวเลือก
เนื่องจากไม่มีที่ใดที่จะใส่ตัวเลือกบนบรรทัดคำสั่งสำหรับคอมไพเลอร์ C

สิ่งนี้จะอ้างอิงโยงและจัดทำเอกสารไฟล์ต้นฉบับ C เท่านั้นเนื่องจากเป็นไฟล์เดียว
ที่รวบรวมไว้ แต่จะทำให้แน่ใจว่ามีการอ้างอิงโยงกับ
ตัวเลือกที่ถูกต้อง ฯลฯ

อ้างอิง องค์ประกอบ เนื้อไม่มีมัน
อาร์กิวเมนต์บรรทัดคำสั่งเหล่านี้ยังสามารถใส่ลงในไฟล์ชื่อ `.cxref' แทนที่จะเป็นบน
บรรทัดคำสั่ง. เมื่อเรียกใช้ cxref อาร์กิวเมนต์ของโปรแกรมจะถูกตีความใน
ตามคำสั่ง

(1) ผู้ที่อยู่ในบรรทัดคำสั่ง (2) ที่อยู่ในไฟล์ `.cxref' ในไดเร็กทอรีปัจจุบัน
(3) สิ่งเหล่านั้นในไฟล์ `.cxref' ในรากต้นไม้ต้นทางที่ระบุโดย `-R'

ซึ่งหมายความว่าในแผนผังซอร์สแบบหลายไดเร็กทอรี แต่ละไดเร็กทอรีย่อยสามารถมี `.cxref'
ไฟล์ที่มีเพียงบรรทัด `-R.. ' หรือเหมาะสม ไดเร็กทอรีหลักสามารถมี a
ไฟล์ `.cxref' ที่มีตัวเลือกที่เหลือ สิ่งนี้จะขจัดความจำเป็นโดยสิ้นเชิง
เพื่อให้มีตัวเลือกในบรรทัดคำสั่งนอกเหนือจากชื่อไฟล์ต้นทาง

รูปแบบของไฟล์ `.cxref' คือจำนวนบรรทัดใดก็ได้ โดยแต่ละบรรทัดมีไฟล์เดียว
อาร์กิวเมนต์บรรทัดคำสั่ง (เทียบเท่ากับหนึ่งใน argv) ทางเลือกเดียวที่ทำไม่ได้
ใช้เป็นชื่อของไฟล์ต้นฉบับและตัวเลือก `-delete' เส้นเปล่าคือ
ละเว้นและบรรทัดที่ขึ้นต้นด้วย '#' คือความคิดเห็น

โครงการ เอกสาร ความคิดเห็น
เอกสารประกอบสำหรับโปรแกรมสร้างจากความคิดเห็นในโค้ดที่
จัดรูปแบบอย่างเหมาะสม การอ้างอิงโยงมาจากตัวโค้ดเองและไม่ต้องใช้
งานพิเศษ.

ความคิดเห็นพิเศษคือ `/**** ****/' (สำหรับไฟล์) และ `/*++++ +++++/' (สำหรับข้อมูล
วัตถุ) จำนวนใด ๆ ของ `*' หรือ `+' สามารถใช้ภายในความคิดเห็น `/*' และ `*/' มาตรฐาน
ตัวคั่นในความคิดเห็นจะถูกละเว้น

หากบรรทัดความคิดเห็นเริ่มต้นด้วยช่องว่างและตามด้วย `+html+' ส่วนที่เหลือของ
รวมบรรทัดในเอาต์พุต HTML เท่านั้น และไม่ได้ประมวลผลเพื่อให้สามารถรวม HTML . ได้
มาร์กอัป `-html-' หมายความว่าส่วนที่เหลือของบรรทัดรวมอยู่ในทั้งหมดยกเว้น HTML
เอาท์พุท เช่นเดียวกับรูปแบบเอาต์พุตอื่นๆ สามารถใช้ `+none+' สำหรับบรรทัด
ไม่ให้ปรากฏในผลงานใดๆ ข้อยกเว้นคือผลลัพธ์ดิบไม่ทำอะไรเลย
กำลังตรวจสอบและจะส่งออกทุกบรรทัด

ในสถานการณ์ใด ๆ ที่ความคิดเห็นตามหลัง `,', `;' หรือ `)' คั่นด้วยช่องว่างเท่านั้นและ
แท็บ ความคิดเห็นจะถูกผลักไปก่อนเครื่องหมายวรรคตอนเพื่อนำไปใช้กับวัตถุที่นั่น

โปรแกรมดำเนินการโดยใช้ตัวแยกวิเคราะห์ไวยากรณ์ ANSI C เต็มรูปแบบพร้อมส่วนขยาย GCC บางตัว
ซึ่งหมายความว่ารูปแบบของโค้ดไม่สำคัญ เฉพาะเนื้อหาและความคิดเห็นเท่านั้น

ข้าม อ้างอิง
การอ้างอิงโยงจะดำเนินการสำหรับรายการต่อไปนี้

ไฟล์
ไฟล์ที่ไฟล์ปัจจุบันรวมอยู่ใน
(แม้จะรวมไว้ในไฟล์อื่นๆ)

#รวมถึง
ไฟล์ที่รวมอยู่ในไฟล์ปัจจุบัน
ไฟล์ที่รวมอยู่ในไฟล์เหล่านี้ ฯลฯ

ตัวแปร
ตำแหน่งของคำจำกัดความของตัวแปรภายนอก
ไฟล์ที่มีการมองเห็นตัวแปรส่วนกลาง
ไฟล์/ฟังก์ชันที่ใช้ตัวแปร

ฟังก์ชั่น
ไฟล์ที่ฟังก์ชันถูกสร้างต้นแบบ
ฟังก์ชันที่ฟังก์ชันเรียกใช้
ฟังก์ชันที่เรียกใช้ฟังก์ชัน
ไฟล์และฟังก์ชันที่อ้างอิงถึงฟังก์ชัน
ตัวแปรที่ใช้ในฟังก์ชัน

แต่ละรายการเหล่านี้มีการอ้างอิงโยงในผลลัพธ์

การอ้างอิงโยงใช้ไฟล์ `cxref.variable', `cxref.function', `cxref.include' และ
`cxref.typedef' ในไดเร็กทอรีเอาต์พุต นี่คือรายการฟังก์ชันทั้งหมดและ
การใช้งานตัวแปรในโปรแกรมและสามารถใช้สร้างลำดับชั้นการเรียกฟังก์ชันหรือ
ไดอะแกรมการใช้ตัวแปรเช่น จำเป็นต้องใช้ cxref pass สองครั้งสำหรับแต่ละไฟล์ โดยเป็นไฟล์แรก to
สร้างไฟล์อ้างอิงโยงและไฟล์ที่สองเพื่อใช้

(ชื่อไฟล์จะต่างกันหากใช้ตัวเลือก `-N')

น้ำยาง เอาท์พุต
เอาต์พุต LaTeX เริ่มต้นคือไฟล์สำหรับไฟล์ต้นทางแต่ละไฟล์ที่มีไฟล์พิเศษหนึ่งไฟล์
`cxref.tex' ที่รวมแต่ละไฟล์อื่นๆ นี่คือการอนุญาตให้ makefile เท่านั้น
อัปเดตไฟล์ที่เปลี่ยนแปลง (แม้ว่าการอ้างอิงอาจต้องการให้ไฟล์ทั้งหมดเป็น
ตรวจสอบอีกครั้ง) เมื่อไฟล์ cxref.tex ถูกเขียนขึ้น ผู้ใช้จะสามารถแก้ไขได้
ไฟล์ใหม่ที่เพิ่มเข้ามาจะถูกเพิ่มที่ส่วนท้ายของส่วนซอร์สโค้ด ส่วนที่เหลือของ
ไฟล์ไม่เปลี่ยนแปลง

ดัชนีถูกเขียนลงในไฟล์ชื่อ `cxref.apdx.tex' และ cxref.tex ได้รับการอัพเดตเพื่ออ้างอิง
เพื่อมัน

นอกจากนี้ ยังมีไฟล์สไตล์ LaTeX สามไฟล์ `page.sty', `fonts.sty' และ `cxref.sty'
สิ่งเหล่านี้ตั้งค่าหน้าให้ใช้ระยะขอบที่เล็กกว่าและแบบอักษรที่เล็กกว่าเพื่อให้ปรากฏเพิ่มเติมบน
หน้าและยังกำหนดคำสั่งใหม่สำหรับการเรียงพิมพ์เอาต์พุต cxref

(ชื่อไฟล์ `cxref.tex' และ `cxref.apdx.tex' จะแตกต่างกันหากตัวเลือก `-N' คือ
ใช้แล้ว.)

HTML เอาท์พุต
เอาต์พุต HTML เริ่มต้นคือไฟล์สำหรับไฟล์ต้นฉบับแต่ละไฟล์ที่มีไฟล์พิเศษหนึ่งไฟล์
`cxref.html' ที่รวมแต่ละไฟล์อื่นๆ นี่คือการอนุญาตให้ makefile เท่านั้น
อัปเดตไฟล์ที่เปลี่ยนแปลง (แม้ว่าการอ้างอิงอาจต้องการให้ไฟล์ทั้งหมดเป็น
ตรวจสอบอีกครั้ง) เมื่อไฟล์ cxref.html ถูกเขียนขึ้น ผู้ใช้จะสามารถแก้ไขได้
ไฟล์ใหม่ที่เพิ่มเข้ามาจะถูกเพิ่มในตอนท้ายก่อนสารบัญส่วนที่เหลือ
ของไฟล์ที่ไม่เปลี่ยนแปลง

ดัชนีถูกเขียนลงในไฟล์ชื่อ `cxref.apdx.html' และ cxref.html ได้รับการอัปเดตเพื่ออ้างอิง
เพื่อมัน

(ชื่อไฟล์ `cxref.html' และ `cxref.apdx.html' จะแตกต่างกันหากตัวเลือก `-N' คือ
ใช้แล้ว.)

เอาต์พุต HTML ใช้มาตรฐาน HTML 4.01 และทุกหน้าตรวจสอบอย่างถูกต้อง

RTF เอาท์พุต
Rich Text Format คือรูปแบบคำอธิบายเพจระดับต่ำที่พัฒนาโดย Microsoft มัน
ไม่ใช่มาตรฐานที่กำหนดไว้อย่างดีและเข้าใจง่าย เช่นเดียวกับรูปแบบอื่นๆ แต่เป็น
นิยมแลกเอกสาร

มีไฟล์เอาต์พุตไฟล์เดียวสำหรับแต่ละไฟล์ต้นทางและไฟล์ดัชนี

เอสจีเอ็มแอล เอาท์พุต
เนื่องจาก SGML เป็นภาษาเมตา จึงจำเป็นต้องกำหนดองค์ประกอบโครงร่างและ
ให้ข้อมูล เอาต์พุต cxref ใช้รูปแบบเอกสาร LinuxDoc และ is
ออกแบบมาเพื่อใช้กับโปรแกรม SGMLtools (http://www.sgmltools.org/).

มีไฟล์เอาต์พุตไฟล์เดียวสำหรับแต่ละไฟล์ต้นทางและไฟล์ดัชนี

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