Automatic generation of API documentations for open-source projects

Xin Peng, Yifan Zhao, Mingwei Liu, Fengyi Zhang, Yang Liu, Xin Wang, Zhenchang Xing

    Research output: Chapter in Book/Report/Conference proceedingConference contributionpeer-review

    8 Citations (Scopus)

    Abstract

    Open-source projects often have only incomplete and insufficient API documentations. To improve the efficiency of development and ensure the correctness of API usage, it is desired that the developers can be supported with automatically gener- A ted documentation based on a combination of knowledge from different sources. In this paper, we describe OpenAPIDocGen, a system that can automatically generate API Documentations for open-source projects, including an overview of the system and the data sources and techniques used to generate different parts of the documentation.

    Original languageEnglish
    Title of host publicationProceedings - 3rd International Workshop on Dynamic Software Documentation, DySDoc3 2018
    PublisherInstitute of Electrical and Electronics Engineers Inc.
    Pages7-8
    Number of pages2
    ISBN (Electronic)9781538675700
    DOIs
    Publication statusPublished - 9 Nov 2018
    Event3rd International Workshop on Dynamic Software Documentation, DySDoc3 2018 - Madrid, Spain
    Duration: 25 Sept 2018 → …

    Publication series

    NameProceedings - 3rd International Workshop on Dynamic Software Documentation, DySDoc3 2018

    Conference

    Conference3rd International Workshop on Dynamic Software Documentation, DySDoc3 2018
    Country/TerritorySpain
    CityMadrid
    Period25/09/18 → …

    Fingerprint

    Dive into the research topics of 'Automatic generation of API documentations for open-source projects'. Together they form a unique fingerprint.

    Cite this