Skip to content
GitLab
Projects Groups Topics Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • backend backend
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Graph
    • Compare revisions
  • Issues 12
    • Issues 12
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 0
    • Merge requests 0
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Releases
  • Packages and registries
    • Packages and registries
    • Container Registry
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • subugoesubugoe
  • ahiqarahiqar
  • backendbackend
  • Merge requests
  • !6

Feature/improve api docs

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Michelle Weidling requested to merge feature/improve-API-docs into develop May 14, 2020
  • Overview 20
  • Commits 9
  • Pipelines 7
  • Changes 5

Summary

This MR provides an enhancement of the existing function documentation (including some slight refactoring and indenting) of the Ahiqar backend as far as I understood it. Please correct or point out every misunderstanding on my side.

Changes have moved from repo.xml to a CHANGELOG to 1. improve the visibility of changes and 2. to make keeping track of changes easier (in this case Markdown > HTML).

repo.xml now lists Michelle Weidling as additional author.

Use Cases

With a proper function documentation we can easily provide HTML rendered docs of our API. It also might help anyone interested to understand the API better.

Changelog

  • I added a statement to the CHANGELOG.

Related Tickets

subugoe/emo/Qviewer#8

/cc @schneider210 @mgoebel

Edited Jun 04, 2020 by Michelle Weidling
Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: feature/improve-API-docs