Utilizing a schema for documenting managed code
First Claim
Patent Images
1. A method for documenting managed code, comprising:
- defining an element structure for each element of managed code to be documented that is incorporated in an Assistance Markup Language (AML) schema including defining element structures for each of;
a class;
a method;
a constructor; and
an Interface;
defining semantically-marked content for documenting elements of managed code that are Application Programming Interface (API) elements, wherein the semantically-marked content follows the Assistance Markup Language (AML) schema;
including definitions for the elements of the managed code to be documented within the AML schema;
transforming the semantically-marked content to create presentational content for display according to a definition specifying the display of the content.
2 Assignments
0 Petitions
Accused Products
Abstract
A schema is provided that supports documenting API elements that is flexible and captures current technologies as well as evolves without interfering or breaking the definitions of the existing elements. The schema utilizes a flexible and extensible element that can be used to define various elements of the APIs and can be extended to define new technology when it is introduced.
-
Citations
20 Claims
-
1. A method for documenting managed code, comprising:
-
defining an element structure for each element of managed code to be documented that is incorporated in an Assistance Markup Language (AML) schema including defining element structures for each of;
a class;
a method;
a constructor; and
an Interface;defining semantically-marked content for documenting elements of managed code that are Application Programming Interface (API) elements, wherein the semantically-marked content follows the Assistance Markup Language (AML) schema; including definitions for the elements of the managed code to be documented within the AML schema; transforming the semantically-marked content to create presentational content for display according to a definition specifying the display of the content. - View Dependent Claims (2, 3, 4, 5, 6, 7, 8)
-
-
9. A computer-readable storage medium having computer-executable instructions for documenting managed code, comprising:
-
defining an element structure for each element of managed code to be documented including defining element structures for each of;
a class;
a method;
a constructor; and
an Interface and incorporating each of the element structures into an Assistance Markup Language (AML) schema;obtaining semantically-marked content that provides documentation for documenting elements of managed code, wherein the semantically-marked content follows the Assistance Markup Language (AML) schema; and obtaining definitions for the elements of the managed code that follow the AML schema. - View Dependent Claims (10, 11, 12, 13, 14, 15, 16)
-
-
17. A system for using an AML schema for documenting managed code, comprising:
-
a processor and a computer-readable medium; an operating environment stored on the computer-readable medium and executing on the processor; a mass storage device that is configured to store semantically-marked content that documents elements of managed code, wherein the semantically-marked content follows an Assistance Markup Language (AML) schema that includes element structure for each element of managed code to be documented including defining element structures for each of;
a class;
a method;
a constructor; and
an Interface; anda content transformation manager operating under the control of the operating environment and operative to; accessing the semantically-marked content; obtaining definitions for the elements of the managed code from the AML schema; and transforming the semantically-marked content to create presentational content. - View Dependent Claims (18, 19, 20)
-
Specification