Uploaded image for project: ' AGL Development'
  1. AGL Development
  2. SPEC-1312

AGL web docs should have the detail API document

    XMLWordPrintable

    Details

      Description

      To call other process's API (service), the websocket and json format are used in AGL.

      To get the information of verbs and keys of parameters to be set, we have to look source code.

      I think it is useful for people to get all API information(verb information) from docs-agl generated by doxygen and it's good for maintainance.

       

      My ideas are following but other ways are welcome

      • API information should be generated automatically from source code to reduce the maintenance cost
      • Fetch the gerrit repository and generate document from doxyfile if it exists
      • Then make the link to index.html.

      I am willing to try to extend docs-agl, but it's the first time for me to use nodejs in docs-agl.

      I may need your help.

        Attachments

          Issue Links

          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

            Activity

              People

              Assignee:
              Unassigned
              Reporter:
              knimitz Kazumasa Mitsunari
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Due:
                Created:
                Updated: