Làm cách nào để tạo tài liệu trên Linux?

Tôi sử dụng Zeal để tra cứu tài liệu API trên Linux. Nó yêu cầu tệp phải ở định dạng tài liệu của Apple có định dạng.Làm cách nào để tạo tài liệu trên Linux?

Tôi có mã C++ mà tôi có thể tạo tài liệu bằng cách sử dụng Doxygen. Doxygen có thể xây dựng một docset, nhưng nó đòi hỏi chương trình docsetutil, không có sẵn trên Linux.

Có phương pháp nào khác để tạo tài liệu của một codebase C++ trên Linux không?

Nguồn

2015-10-02 Ashwin Nanjappa

"No need for docsetutil if you're generating a Dash-only docset," đề xuất nhà phát triển Dash. Tương tự như vậy according to the Dash documentation, bạn cần các mục sau trong tập tin cấu hình Doxygen để tạo ra DocSet (người cuối cùng 3 là không bắt buộc):

GENERATE_DOCSET = YES 
DISABLE_INDEX  = YES 
SEARCHENGINE  = NO 
GENERATE_TREEVIEW = NO

Nguồn

2016-01-26 00:03:21 Cahit

Tôi là một chút bối rối tôi không tìm thấy điều này bản thân mình! Cảm ơn bạn đã thực hiện công việc legwork và chỉ ra điều này - giải quyết vấn đề của tôi theo cách khác (và đơn giản hơn!) So với dự đoán của tôi. – cincodenada

Trong trường hợp người khác tự hỏi: Bạn cần chạy doxygen với cấu hình đúng, hãy chạy bên trong thư mục html. Thực hiện sẽ thất bại nhưng sẽ làm đủ công việc. Docset được đặt dưới dạng thư mục con trong thư mục html có tên là * .docset – olejorgenb

Tôi đã cố gắng tạo một tài liệu cho SDL 2.0.4, lần đầu tiên chạy doxygen và sử dụng MSYS trên Windows, sau đó làm lại nó trên Linux Mint. Cả hai lần, như mong đợi, makefile thất bại khi yêu cầu docsetutil không được tìm thấy. Nhưng cả hai lần, các tập tin tạo ra là * KHÔNG * đủ - với thư mục docset nơi Zeal tìm kiếm chúng, không có dấu hiệu của các tài liệu trong Zeal. Tôi đã thử giả mạo một tập tin meta.json kể từ khi không được tạo ra - không giúp đỡ, cộng với điều đó và một số biểu tượng cũng bị thiếu từ doco mono hoạt động. Tiếp theo nghi ngờ - docSet.dsidx - mọi docset tôi có, nhưng nó không được tạo cho SDL. – Steve314

Làm cách nào để tạo tài liệu trên Linux?

Trả lời

Các vấn đề liên quan