[haddock] #38: Add a way to indicate DEPRECATED functions/types/modules

haddock haddock at projects.haskell.org
Sun Jun 21 17:50:13 EDT 2009


#38: Add a way to indicate DEPRECATED functions/types/modules
------------------------+---------------------------------------------------
Reporter:  waern        |        Owner:     
    Type:  enhancement  |       Status:  new
Priority:  minor        |    Milestone:     
 Version:               |   Resolution:     
Keywords:               |  
------------------------+---------------------------------------------------
Comment (by duncan):

 Using the existing GHC deprecated pragma would be ideal I think. See for
 example the gtk-doc output for deprecated stuff:

 http://library.gnome.org/devel/gtk/stable/gtk-General.html#gtk-timeout-
 add-full

 Related to saying that something is deprecated is saying when it was
 deprecated. This aspect is related to ticket #25 and #26. My personal
 opinion on both is that it should not be indicated in the source but
 passed in (eg by Cabal) as auxiliary information that is derived using
 another tool that compares package versions.

-- 
Ticket URL: <http://trac.haskell.org/haddock/ticket/38#comment:1>
haddock <http://www.haskell.org/haddock>
Haddock, The Haskell Documentation Tool


More information about the Haddock mailing list