2012-02-01 10 views
19

Tôi đã thêm này cho một người bình luận lớp:Doxygen @link đến một URL không tạo ra sự liên kết một cách chính xác

@link http://www.google.com Google @endlink 

Tuy nhiên, khi tôi tạo ra tài liệu hướng dẫn sử dụng doxygen, văn bản liên kết thực sự là "Google", nhưng liên kết là:

file: ///media/portable/Examples/Doxygen/link/html/classClass1.html

bất cứ ai có thể giải thích những gì đang xảy ra vậy?

Trả lời

29

Tôi nghĩ bạn đang sử dụng \link không chính xác. Từ doxygen documentation, \link được sử dụng để chỉ các đối tượng như một tệp, lớp hoặc thành viên và tham chiếu đến một trong các đối tượng này làm đối số đầu tiên của nó. Ví dụ, nếu tôi muốn đề cập đến một phương pháp lớp func trong lớp myClass, tôi sẽ sử dụng

\link myClass::func link text ... \endlink 

với tất cả các đối số còn lại được coi là văn bản cho một liên kết. Tôi nghĩ rằng vấn đề của bạn là bạn không vượt qua một đối tượng hợp lệ làm đối số đầu tiên. Tôi đoán rằng classClass1 là đối tượng tiếp theo trong tệp mà bạn đã cố gắng bao gồm liên kết và đây là những gì lệnh \link đang tham chiếu đến.

Liên kết tới URL

Doxygen sẽ tạo ra các liên kết URL tự động, do đó không cần phải bao quanh liên kết với \link\endlink hoặc bất kỳ lệnh khác. Vì vậy, loại bỏ những người và xem nếu đó sửa chữa vấn đề.

Để tự xác định văn bản liên kết, sử dụng HTML 'a' tag:

<a href="linkURL">link text</a> 

Để biết thêm thông tin về doxygen xử lý tự động như thế nào liên kết trang tài liệu see this.

+0

Tôi hiểu, cảm ơn Chris! –