ハドック：デフォルトのクラスのドキュメントに置き換え癖を持つインスタンス関数のドキュメント

Question

は、次の例を考えてみましょう：

instance (Monad m) => MonadState s (ChronoT s e m) where 

    -- | Returns the present-day state. 
    get = ChronoT $ do 
     (ChronoS _ s _) <- get 
     return s 

    -- | Set the present-day state directly, erasing the past and future for 
    -- safety. See also 'paradox'. 
    put x = ChronoT $ do 
     (ChronoS _ _ _) <- get 
     put $ mkChronoS x 

ハドックを介して実行すると、機能getとputが現れ、彼らはMonadStateから既定のドキュメントを使用しています。自分のモジュールに自分のドキュメントを含めるにはどうしたらいいですか？

（あなたは私がレポhere上cabal haddockを実行して、何を意味するかを見ることができます）

Answer 1

あなたがすることはできません。

あなたのできることは、あなたのインスタンスをドキュメント化することです。

-- | You can have a brief description here 
instance (Monad m) => MonadState s (ChronoT s e m) where 
… 

これにより、生成されたinstancesボックスの横に説明が表示されます。これは簡単に行うのが望ましいはずですが、実際に必要な場合は、質問のコメント作成者のように、フィールドを実装する関数のドキュメントをユーザーに指摘するなどの作業をさせることができます。

個人的には、このように各フィールドを文書化することは意味がないと思います。フィールドの意味は、クラス定義の文書化とインスタンスへのコメントから明らかにしてください。