International Business Machines Corporation

Michael Priestly

Andrew Lawrence Frenkiel

Yi Zhou

Wen Ke Xue

Alyson-Kathleen Riley

Various embodiments synchronize comments in a source code file with text of a source code document. In one embodiment, a source code file is analyzed. A set of source code comment text within the source code file is identified. A set of text is extracted from the set of source code comment text that has been identified. A set of metadata is generated for at least the set of text. A plurality of markup tags is applied to the set of text. The plurality of markup tags at least one of format and stylize the set of text when presented to the user. A source code document is generated that includes one or more of the set of text, the set of metadata, and the plurality of markup tags.

Synchronizing comments in source code with text documents

Automated creation of augmented documentation fragments that are augmented with usage examples. A plurality of documentation fragments is stored, where each documentation fragment documents a software element and has at least one associated property. A corresponding source code software fragment that corresponds to at least one associated property of at least one software element is identified based on an automated software analysis process of source code within a source code repository and further based on a list of properties comprising each associated property of each software element within the plurality of software elements. An augmented documentation fragment that includes a selected documentation fragment and the at least one corresponding source code software fragment corresponding to at least one associated property of the selected documentation fragment is created in response to the identifying.

Software documentation generation with automated sample inclusion

Various embodiments synchronize comments in a source code file with text of a source code document. In one embodiment, a source code document is compared to a corresponding source code file. The source code document comprises a set of text corresponding to a set of source code comment text in the corresponding source code file. The source code document is configured to display the set of text in a stylized format when presented to a user. The set of text in the source code document is determined to be different than the set of source code comment text in the source code file based on the comparison. At least the set of source code comment text in the source code file is automatically changed based on the set of text from the source code document and in response to the determination.

A method for related page identification based on page hierarchy and subject hierarchy includes receiving, by a computer, an identification of a current page from a user, the current page being located in a first page hierarchy; identifying a subject tag in the current page; locating the identified subject tag in a subject hierarchy; identifying a related page that is related to the current page based on the subject hierarchy, the related page being located in a second page hierarchy; determining a scope of the related page with respect to the current page based on the first page hierarchy and the second page hierarchy by the computer; navigating the second page hierarchy to determine a suggested page for the user, the suggested page having a desired scope with respect to the current page; and suggesting the suggested page to the user.

Growing community of inventors

Toronto, Canada

Michael Priestly