Automatically generating documentation on application programming interfaces
AssigneeRed Hat, Inc.
InventorJustin Lee Sherrill
Life of this patent
Estimating the term…
Abstract
Some embodiments of a system and a method to automatically generate documentation on application programming interfaces (APIs) have been presented. For instance, while a processor is building a software system from programming code including APIs, the processor may extract objects related to the APIs from comments embedded in the programming code and automatically generate documentation on the APIs using the objects extracted and templates associated with the objects extracted.
Claims24
A method comprising:
- building, by a processing device, a software system from programming code comprising application programming interfaces (APIs);
- extracting, by the processing device, objects related to the APIs;
- executing, by the processing device, macros embedded in comments using templates associated with the objects extracted, wherein the comments are embedded in the programming code;
- and
- generating, by the processing device, documentation on the APIs using the objects extracted and the executed macros while building the software system.
A system comprising:
- a memory;
- a processing device coupled to the memory, wherein the processing device is configured to:
- build a software system from programming code comprising application programming interfaces (APIs), extract objects related to the APIs, execute macros embedded in comments using templates associated with the objects extracted, wherein the comments are embedded in the programming code and generate documentation on the APIs using the objects extracted and the executed macros while building the software system.
A non-transitory computer-readable storage medium embodying instructions that, when executed by a processing device, will cause the processing device to perform a method comprising:
- building, by a processing device, a software system from programming code comprising application programming interfaces (APIs);
- extracting, by the processing device, objects related to the APIs;
- executing, by the processing device, macros embedded in comments using templates associated with the objects extracted, wherein the comments are embedded in the programming code;
- and
- generating, by the processing device, documentation on the APIs using the objects extracted and the executed macros while building the software system.
Dependencies are inferred from the claim text.