2011-12-13 13 views
19

Khi bạn đặt con trỏ chuột lên bất kỳ hàm/lớp Qt nào, nó sẽ hiển thị một cửa sổ bật lên với mô tả ngắn về những gì nó làm, được lấy từ các tài liệu trong chú thích ở trên hàm/lớp.Làm cách nào để Qt Creator hiển thị tài liệu bật lên của các chức năng của tôi giống như cách thực hiện cho các chức năng từ thư viện Qt?

Đối với chức năng của tôi/classes Tôi có tài liệu theo định dạng doxygen:

/** 
    Returns foo 
*/ 
QString getFoo() { 
    return "foo"; 
} 

Khi chức năng này được sử dụng, tôi muốn xem cùng một loại pop-up với tài liệu của tôi khi con trỏ chuột đã qua tên hàm.

Có thể thực hiện điều đó với Trình tạo Qt không?

Trả lời

10

Rất tiếc, không thể tạo Qt Creator (kể từ bản phát hành gần đây 2.4) để nhận thẻ trực tuyến. Tuy nhiên, những gì có thể làm là để cho doxygen chạy, và bảo nó tạo các tệp qch. Nếu bạn đăng ký tệp qch đã tạo, bạn sẽ nhận được chuột qua và thậm chí là tệp trợ giúp thích hợp. Xem http://www.ogre3d.org/tikiwiki/Integrating+API+documentation+into+Qt+Creator+Help để biết cách Ogre3D thực hiện. YMMV nếu điều đó đáng giá đối với một dự án thay đổi nhanh. Nó chắc chắn là một ý tưởng tốt cho một thư viện (bán) ổn định.

có liên quan báo cáo lỗi: https://bugreports.qt.io/browse/QTCREATORBUG-4557

+0

Tôi rất tiếc khi biết rằng điều này là không thể. Vì nó đã hiển thị khai báo hàm trên chuột khi đang di chuyển, nó rất gần với việc hiển thị các tài liệu, điều này thật tuyệt vời. Cách tiếp cận tạo các tệp qch có thể sẽ hoạt động, nhưng nó không thuận tiện nếu bạn đang tích cực phát triển một thư viện, đó là những gì tôi làm hàng ngày. –

+2

Tôi đồng ý, nhưng tôi thậm chí không thể tìm thấy một vấn đề về nó trong cơ sở dữ liệu lỗi. Bạn có thể muốn gửi báo cáo lỗi tại http://bugreports.qt.nokia.com hoặc đăng ký danh sách gửi thư qt-creator để giúp triển khai tính năng đó. – danimo

+0

@danimo Điều này vẫn còn hợp lệ cho Qt Creator phiên bản 4.2.0? – maxik

3

Qt Creator đòi hỏi các tài liệu được tạo ra để có một số dấu hiệu đặc biệt để lấy văn bản tooltip. Tôi không thể tìm thấy một cách để chèn các điểm đánh dấu với Doxygen vì vậy tôi đã tạo ra một kịch bản đơn giản để làm điều đó:

https://github.com/mmmarcos/doxygen2qtcreator

Nó không phải đạn nhưng nó cho phép chúng tôi để tích hợp các lớp học của chúng tôi và phương pháp tóm tắt vào Qt Chú giải công cụ dành cho người tạo.

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