forked from docascode/docfx-seed
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
50 additions
and
55 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
uid: CatLibrary.Cat`2.CalculateFood(System.DateTime) | ||
name: "Override CalculateFood Name" | ||
summary: "It's an overridden summary in `markdown` format" | ||
syntax: | ||
parameters: | ||
- id: date | ||
description: "This is overridden description for a parameter. `id` must be specified." | ||
return: | ||
type: System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.Int32}} | ||
description: "It's overridden description for return. `type` must be specified." | ||
exceptions: | ||
- type: System.ArgumentException | ||
description: "This is an `overridden` argument exception. you can add additional exception by adding different exception `type`." | ||
--- | ||
|
||
This is overriding methods. You can override parameter descriptions for methods, you can even add exceptions to methods. Check the intermediate `obj` folder to see the data model of the generated method/class. Override Yaml header should follow the data structure. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
uid: CatLibrary.IAnimal | ||
remarks: '*THIS* is remarks overridden in *MARKDWON* file' | ||
--- | ||
|
||
### Welcome to the **Animal** world! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
uid: petstore.swagger.io/v2/Swagger Petstore/1.0.0/addPet | ||
footer: *content | ||
--- | ||
> NOTE: Add pet only when you needs. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
--- | ||
uid: petstore.swagger.io/v2/Swagger Petstore/1.0.0 | ||
title: Pet Store APIs | ||
footer: *content | ||
--- | ||
|
||
### See Alsos | ||
|
||
See other REST APIs: | ||
* [Contacts API](../restapi/contacts_swagger2.json) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
uid: petstore.swagger.io/v2/Swagger Petstore/1.0.0/tag/pet | ||
description: *content | ||
--- | ||
|
||
Description for pet tag |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
uid: petstore.swagger.io/v2/Swagger Petstore/1.0.0/tag/store | ||
--- | ||
|
||
Additional description for store tag |