Synopsis - Issue Tracker

Task41 Editing

Title Simplify comment markup processing
Created on 2006-04-02.04:44:50 by stefan, last changed 2006-04-28.12:48:47. by stefan
assigned to stefan priority normal
type coding solves
topic components general
status closed result done
depends on superseded by
Add Comment:
File
CC List:? stefan

Messages
Author: stefan Date: 2006-04-02.04:44:50
Right now comments are processed in multiple steps,
from filtering over parsing to formatting. This is
overly complex.
While the filtering has to be done in a separate
step (due to the fact that we support different
languages with distinct rules concerning what
constitutes a comment), there is no need to separate
parsing and formatting.
However, as different source files may use different
comment conventions, a processor is needed that
can annotate individual source files with the
markup style that is to be used.
Then formatters can provide facilities to parse
and format comments based on that annotation.
Author: stefan Date: 2006-04-10.02:28:58
Most of this is now implemented. A 'translator'
generates 'doc' annotations from 'comments' 
annotations, and allows to set a markup attribute,
which is then used during formatting.

Some Python Enhancement Proposals seem to suggest
to embedd a '__docformat__' string into each
module, which makes passing a markup specifier
to the document extractor redundant.
Synopsis should honor such embedded metadata.
History
Date User Action Args
2006-04-02 04:44:50stefancreate
2006-04-10 02:28:59stefansetstatus: new
assignedto: + stefan
task_type: (no value)
messages: + msg540
components: + general
2006-04-28 12:48:47stefansetstatus: open
result: (no value)