Auto_Docs/api-docs.json at main · Katari-8055/Auto_Docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
[
  {
    "file": "src/database.js",
    "description": "Connects the application to the MongoDB database.",
    "tags": [
      {
        "tag": "param",
        "name": "uri",
        "type": "string",
        "description": "- The MongoDB connection URI."
      },
      {
        "tag": "returns",
        "name": "The",
        "type": "Promise<object>",
        "description": "MongoDB connection object."
      },
      {
        "tag": "example",
        "name": "",
        "type": "",
        "description": "connectDatabase(\"mongodb://localhost:27017/mydb\");"
      }
    ]
  },
  {
    "file": "src/database.js",
    "description": "Closes the MongoDB database connection.",
    "tags": [
      {
        "tag": "returns",
        "name": "Resolves",
        "type": "Promise<void>",
        "description": "when the connection is closed."
      },
      {
        "tag": "example",
        "name": "",
        "type": "",
        "description": "closeDatabase();"
      }
    ]
  },
  {
    "file": "src/example.js",
    "description": "Adds two numbers together.",
    "tags": [
      {
        "tag": "param",
        "name": "a",
        "type": "number",
        "description": "- The first number."
      },
      {
        "tag": "param",
        "name": "b",
        "type": "number",
        "description": "- The second number."
      },
      {
        "tag": "returns",
        "name": "The",
        "type": "number",
        "description": "sum of a and b."
      }
    ]
  },
  {
    "file": "src/example.js",
    "description": "Greets a user by name.",
    "tags": [
      {
        "tag": "param",
        "name": "name",
        "type": "string",
        "description": "- The user to greet."
      },
      {
        "tag": "returns",
        "name": "The",
        "type": "string",
        "description": "greeting message."
      }
    ]
  },
  {
    "file": "src/index.js",
    "description": "Subtracts the second number from the first number. This function takes two numeric values as input and returns the result of subtracting the second value from the first. It is commonly used in basic arithmetic operations where the difference between two numbers needs to be calculated. The function expects valid numeric inputs. If non-numeric values are provided, the result may be `NaN` depending on JavaScript's type coercion behavior. Example: subtract(10, 4) // returns 6",
    "tags": [
      {
        "tag": "param",
        "name": "a",
        "type": "number",
        "description": "- The first number (minuend) from which another number will be subtracted."
      },
      {
        "tag": "param",
        "name": "b",
        "type": "number",
        "description": "- The second number (subtrahend) that will be subtracted from the first number."
      },
      {
        "tag": "returns",
        "name": "The",
        "type": "number",
        "description": "difference between the first and second numbers."
      }
    ]
  },
  {
    "file": "src/test1.js",
    "description": "Multiplies two numbers.",
    "tags": [
      {
        "tag": "param",
        "name": "a",
        "type": "number",
        "description": "- The first number."
      },
      {
        "tag": "param",
        "name": "b",
        "type": "number",
        "description": "- The second number."
      },
      {
        "tag": "returns",
        "name": "The",
        "type": "number",
        "description": "result of multiplying a and b."
      },
      {
        "tag": "example",
        "name": "",
        "type": "",
        "description": "multiply(2, 3); // returns 6"
      }
    ]
  },
  {
    "file": "src/testing.js",
    "description": "Adds the second number to the first number. This function takes two numeric values as input and returns the result of adding the second value to the first. It is commonly used in basic arithmetic operations where the sum of two numbers needs to be calculated. The function expects valid numeric inputs. If non-numeric values are provided, the result may be `NaN` depending on JavaScript's type coercion behavior. Example: add(10, 4) // returns 14",
    "tags": [
      {
        "tag": "param",
        "name": "a",
        "type": "number",
        "description": "- The first number (addend) to which another number will be added."
      },
      {
        "tag": "param",
        "name": "b",
        "type": "number",
        "description": "- The second number (addend) that will be added to the first number."
      },
      {
        "tag": "returns",
        "name": "The",
        "type": "number",
        "description": "sum of the first and second numbers."
      }
    ]
  }
]