특별 콘텐츠
문서 내용 명령은 문서의 일부, 특수한 렌더링, 개념적 의미 또는 기능이 있는 부분을 식별합니다.
\인용
인용 및 \endquotation 명령은 긴 인용문을 구분합니다.
구분된 블록의 텍스트는 HTML 출력에서 <blockquote> 및 </blockquote>로 둘러싸입니다(예:
/*!
Although the prospect of a significantly broader market is
good news for Firstlogic, the notion also posed some
challenges. Dave Dobson, director of technology for the La
Crosse, Wisconsin-based company, said:
\quotation
As our solutions were being adopted into new
environments, we saw an escalating need for easier
integration with a wider range of enterprise
applications.
\endquotation
*/따옴표 블록의 텍스트는 생성된 HTML에 다음과 같이 표시됩니다:
<blockquote> <p>As our solutions were being adopted into new environments, we saw an escalating need for easier integration with a wider range of enterprise applications.</p> </blockquote>
대부분의 브라우저에 기본 제공되는 스타일 시트는 <따옴표> 태그의 내용을 왼쪽 및 오른쪽 들여쓰기로 렌더링합니다. 위의 예는 다음과 같이 렌더링됩니다:
저희 솔루션이 새로운 환경에 도입되면서 더 다양한 엔터프라이즈 애플리케이션과의 손쉬운 통합에 대한 요구가 점점 더 커지고 있습니다.
하지만 스타일.css 파일에서 <괄호> 태그를 재정의할 수 있습니다.
\참고
note 명령은 굵은 글씨로 "참고:"가 앞에 오는 새 단락을 정의합니다. 이 명령은 연속된 단락을 인수로 사용하며 단락의 끝에서 종료됩니다. note 명령은 짧은 문장에만 사용할 수 있으며 긴 여러 줄 단락에는 사용할 수 없습니다.
경고 명령과 마찬가지로, 메모는 짧고 중요한 문장을 위한 것입니다. 사용법은 Qt 작성 지침을 참고하세요.
\내용 표
QDoc이 이제 목차를 자동으로 생성하기 때문에 \tableofcontents 명령은 비활성화되었습니다.
자동으로 생성된 목차는 페이지의 오른쪽 상단에 표시됩니다.
\brief
brief 명령은 주제 명령에 대한 한 문장으로 된 설명을 소개합니다.
간략 텍스트는 관련 개체의 문서를 소개하는 데 사용되며, \generatelist 명령과 \annotatedlist 명령을 사용하여 생성된 목록에서 사용됩니다.
요약 텍스트는 해당 특정 주제의 문서에 표시됩니다.
예를 들어 부울 QWidget::isWindow 속성입니다:
/*! \property QWidget::isActiveWindow \brief Whether this widget's window is the active window. The active window is the window that contains the widget that has keyboard focus. When popup windows are visible, this property is \c true for both the active window \e and the popup. \sa activateWindow(), QApplication::activeWindow() */
및 QWidget::geometry 속성
/*! \property QWidget::geometry \brief The geometry of the widget relative to its parent and excluding the window frame. When changing the geometry, the widget, if visible, receives a move event (moveEvent()) and/or a resize event (resizeEvent()) immediately. ... \sa frameGeometry(), rect(), ... */
brief 명령을 사용하여 클래스를 설명할 때는 다음과 같이 완전한 문장을 사용하는 것이 좋습니다:
The <classname> class is|provides|contains|specifies...
경고: 간략 설명은 상세 설명의 첫 단락이 되므로 같은 문장으로 상세 설명을 반복하지 마세요.
/*!
\class PreviewWindow
\brief The PreviewWindow class is a custom widget
displaying the names of its currently set
window flags in a read-only text editor.
The PreviewWindow class inherits QWidget. The widget
displays the names of its window flags set with the
setWindowFlags() function. It is also provided with a
QPushButton that closes the window.
...
\sa QWidget
*/네임스페이스에서\brief 사용:
/*! \namespace Qt \brief The Qt namespace contains miscellaneous identifiers used throughout the Qt library. */
헤더 파일에\brief 사용:
/*! \headerfile <QtGlobal> \title Global Qt Declarations \brief The <QtGlobal> header file provides basic declarations and is included by all other Qt headers. \sa <QtAlgorithms> */
property, \class, \namespace 및 \headerfile도 참조하세요.
\legalese
legalese 및 \endlegalese 명령은 라이선스 계약을 구분합니다.
생성된 HTML에서 구분된 텍스트는 <div class="LegaleseLeft"> 및 </div> 태그로 둘러싸여 있습니다.
legalese 및 \endlegalese로 묶인 라이선스 계약의 예시입니다:
/*!
\legalese
Copyright 1996 Daniel Dardailler.
Permission to use, copy, modify, distribute, and sell this
software for any purpose is hereby granted without fee,
provided that the above copyright notice appear in all
copies and that both that copyright notice and this
permission notice appear in supporting documentation, and
that the name of Daniel Dardailler not be used in
advertising or publicity pertaining to distribution of the
software without specific, written prior permission. Daniel
Dardailler makes no representations about the suitability of
this software for any purpose. It is provided "as is"
without express or implied warranty.
Modifications Copyright 1999 Matt Koss, under the same
license as above.
\endlegalese
*/생성된 HTML에 다음과 같이 표시됩니다:
<div class="LegaleseLeft"> <p>Copyright 1996 Daniel Dardailler.</p> <p>Permission to use, copy, modify, distribute, and sell this software for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation, and that the name of Daniel Dardailler not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission. Daniel Dardailler makes no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty.</p> <p>Modifications Copyright 1999 Matt Koss, under the same license as above.</p> </div>
endlegalese 명령을 생략하면 QDoc은 \legalese 명령을 처리하지만 나머지 문서 페이지는 사용권 계약으로 간주합니다.
라이선스 텍스트는 라이선스 코드와 함께 위치하는 것이 가장 이상적입니다.
그렇지 않은 경우, \legalese 명령으로 식별된 문서는 legalese 인자로 \generatelist를 사용하여 누적할 수 있습니다. 이 명령은 소스 코드와 관련된 라이선스 계약의 개요를 생성하는 데 유용합니다.
참고: \generatelist legalese 명령의 출력에는 현재 문서화 프로젝트의 \legalese 텍스트만 포함됩니다. 현재 문서 프로젝트가 다른 모듈에 종속되어 있는 경우에는 해당 라이선스 텍스트가 나열되지 않습니다.
\경고
warning 명령은 명령의 인수 앞에 굵은 글꼴로 "경고:"를 추가합니다.
/*!
Qt::HANDLE is a platform-specific handle type
for system objects. This is equivalent to
\c{void *} on Windows and macOS, and to
\c{unsigned long} on X11.
\warning Using this type is not portable.
*/© 2025 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.
