haddock - 클라우드의 온라인

프로그램:

이름

haddock - 주석이 달린 Haskell 소스 코드를 위한 문서 도구

개요

대구의 일종 [옵션] 파일...

기술

이 매뉴얼 페이지는 간략하게 설명합니다 대구의 일종 명령. 광범위한 문서는
DVI, PostScript 및 HTML을 포함한 다양한 다른 형식으로 사용 가능; 아래를 참조하십시오.

파일 Haskell 소스 모듈을 포함하는 파일 이름입니다. 에 지정된 모든 모듈
명령줄은 함께 처리됩니다. 한 모듈이 다른 모듈의 엔티티를 참조할 때
모듈이 처리되는 동안 문서는 해당 엔터티에 직접 링크됩니다.

예를 들어, 존재하지 않는 모듈에 있기 때문에 찾을 수 없는 엔티티
현재 배치의 일부로 처리되며 생성된 파일에서 하이퍼링크되지 않습니다.
선적 서류 비치. 대구의 일종 할 수 없는 모든 식별자를 나열하는 경고를 내보냅니다.
결의.

모듈은 상호 재귀적이어서는 안 됩니다. 대구의 일종 수영을 좋아하지 않는다
원.

옵션

프로그램은 일반적인 GNU 명령줄 구문을 따르며 긴 옵션은 XNUMX로 시작합니다.
대시(`--'). 아래에 옵션 요약이 포함되어 있습니다. 전체 설명은 다음을 참조하십시오.
다른 문서.

-o DIR, --오디어=DIR
출력 파일을 넣을 디렉토리

-i FILE, --읽기 인터페이스=FILE
에서 인터페이스를 읽다 FILE.

-D FILE, --덤프 인터페이스=FILE
이 모듈에 대한 인터페이스를 덤프하십시오. FILE.

-l DIR, --lib=DIR
Haddock의 보조 파일 위치

-h, --html
HTML 형식으로 문서를 생성합니다. 여러 파일이 생성됩니다.
현재 디렉토리(또는 -o 옵션이 제공됨) 포함
다음 :

index.html 페이지
문서의 최상위 페이지: 다음을 사용하여 사용 가능한 모듈을 나열합니다.
모듈이 계층 구조인 경우 계층 구조를 나타내는 들여쓰기입니다.

해독.css
생성된 HTML에서 사용하는 스타일시트입니다. 이것을 자유롭게 수정하십시오.
색상이나 레이아웃을 변경하거나
--css 옵션을 선택합니다.

모듈.html
각 모듈에 대한 HTML 페이지입니다.

문서 색인.html, 문서-색인-XX.html
인덱스, 두 개로 분할됨(함수/생성자 및 유형/클래스,
Haskell 네임스페이스)를 추가하고 알파벳순으로 더 나눕니다.

--후글
Hoogle에 대한 출력

--html-도움말=체재
mshelp, mshelp2 또는 devhelp 형식으로 색인 및 목차 생성( -h)

--소스 베이스=URL
생성된 문서에 소스 파일에 대한 링크를 포함합니다. 여기서 URL은
소스 파일을 찾을 수 있는 기본 URL입니다.

-s URL, --소스 모듈=URL
생성된 문서에 소스 파일에 대한 링크를 포함합니다. 여기서 URL은
각 모듈에 대한 소스 코드 링크(%{FILE} 또는 %{MODULE} 변수 사용).

--소스 엔터티=URL
생성된 문서에 소스 파일에 대한 링크를 포함합니다. 여기서 URL은
각 엔터티에 대한 소스 코드 링크(%{FILE}, %{MODULE} 또는 %{NAME} 변수 사용).

--설명-기반=URL
목차 및 색인 페이지에 대한 주석 링크의 URL입니다.

--주석-모듈=URL
각 모듈에 대한 주석 링크의 URL(%{MODULE} var 사용).

--설명-엔티티=URL
각 항목의 댓글 링크 URL(%{FILE}, %{MODULE} 또는 %{NAME} 사용)
변수).

--css=FILE
CSS 사용 FILE 함께 제공되는 기본 스타일시트 대신 대구의 일종 HTML용
산출. 특정 클래스를 지정해야 합니다. 자세한 내용은 기본 스타일시트를 참조하세요.

-p FILE, --프롤로그=FILE
프롤로그 텍스트가 포함된 파일을 지정하십시오.

-t TITLE, --제목=TITLE
TITLE 문서의 각 페이지에 대한 페이지 머리글로. 이것은
일반적으로 문서화되는 라이브러리의 이름입니다.

제목은 일반 문자열이어야 합니다(마크업 없음!).

-k 이름, --패키지=이름
패키지 이름을 지정합니다(선택 사항).

-n, --암시적 서곡 없음
Prelude를 가져온 것으로 가정하지 마십시오.

-d, -디버그
추가 디버깅 출력을 활성화합니다.

-?, --도움
도움말을 표시합니다.

-V, --번역
디스플레이 버전.

-v, --말 수가 많은
자세한 상태 보고.

--사용 내용=URL
별도로 생성된 HTML 콘텐츠 페이지를 사용합니다.

--gen-내용
지정된 인터페이스에서 HTML 콘텐츠를 생성합니다.

--사용 인덱스=URL
별도로 생성된 HTML 인덱스를 사용합니다.

--gen-색인
지정된 인터페이스에서 HTML 인덱스를 생성합니다.

--모두 내보내기 무시
모든 모듈에 ignore-exports 속성이 있는 것처럼 작동합니다.

--숨기기=MODULE
마치 MODULE 숨기기 속성이 있습니다.

--사용 패키지=PACKAGE
처리 중인 모듈은 다음에 따라 다릅니다. PACKAGE.

onworks.net 서비스를 사용하여 온라인으로 haddock 사용