Opened 12 years ago

Closed 12 years ago

#262 closed enhancement (worksforme)

quickref mode for chicken-doc

Reported by: felix winkelmann Owned by: Jim Ursetto
Priority: not urgent at all Milestone:
Component: extensions Version:
Keywords: chicken-doc quickref Cc:
Estimated difficulty:

Description

This is a feature request.

It would be cool if chicken-doc could provide a "quickref" mode, where only procedures, macros and parameters (more?) are lised in alphabetical order, somewhat like this:

path: ...

(ask-for-nonconfirmation UNUSED POINTLESS)        ; syntax
(behave-irrationally . MANY-ARGUMENTS)            ; procedure
(consult-consultant [NAME])                       ; procedure
:

Change History (2)

comment:1 Changed 12 years ago by Jim Ursetto

That does sound interesting, but could you explain how it differs from chicken-doc -c path?

That doesn't provide the node type information (syntax, procedure) as you requested, but that's only because it took up too much space.

$ chicken-doc -c posix
_exit                        (_exit [CODE])
block-device?                (block-device? FILENAME)
call-with-input-pipe         (call-with-input-pipe CMDLINE PROC [MODE])
call-with-output-pipe        (call-with-output-pipe CMDLINE PROC [MODE])

comment:2 in reply to:  1 Changed 12 years ago by felix winkelmann

Resolution: worksforme
Status: newclosed

Replying to zbigniew:

That does sound interesting, but could you explain how it differs from chicken-doc -c path?

Oh - I thought, -c would also list subsections and such. Sorry, I wasn't aware of that.

Note: See TracTickets for help on using tickets.