Automatic documentation generation tool and associated method
AssigneeCypress Semiconductor Corporation
InventorsR. Samual Lee, Calvin K. McDonald
Life of this patent
Estimating the term…
Abstract
The invention relates to an automatic documentation tool and associated method. The method includes embedding comments into a plurality of source files defining the design, creating a configuration file including parameters associated with each source file, and extracting the comments from each source file responsive to the parameters. The method is capable of operating on a plurality of source files originating from a plurality of design tools. The method is capable of sorting through keywords preceding each comment and ordering the comments according to a user's request. The method is capable of receiving register definitions from a header file.
Claims29
A method for automatically generating documentation for a design, comprising:
- embedding comments into a plurality of source files defining the design;
- creating a configuration file including parameters associated with each source file;
- and
- extracting the comments from each source file responsive to the parameters.
A computer-readable medium storing a computer program adapted to automatically generate documentation for a product design, the program comprising:
- software adapted to embed comments into at least two source files defining the product;
- software adapted to create a configuration file including parameters associated with the at least two source files;
- and
- software adapted to extract the comments from each source file responsive to the parameters.
A documentation generation tool for a product design, comprising:
- a plurality of source files each adapted to include a plurality of comments;
- a configuration file adapted to include at least one parameter defining an attribute of the product design;
- a program adapted to extract the plurality of comments from each of the plurality of source files responsive to the at least one parameter.
Dependencies are inferred from the claim text.