Skip to content

Commit

Permalink
doc: update api documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@phmatray
phmatray committed Nov 27, 2023
1 parent b87e257 commit 767f1d9
Show file tree
Hide file tree
Showing 66 changed files with 1,075 additions and 305 deletions.
382 changes: 382 additions & 0 deletions docs/candles/Atypical.TechnicalAnalysis.Candles.md
View file

Large diffs are not rendered by default.

166 changes: 166 additions & 0 deletions docs/common/Atypical.TechnicalAnalysis.Common.md
View file

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions docs/functions/Atypical.TechnicalAnalysis.Functions.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#### [TechnicalAnalysis.Functions](Atypical.TechnicalAnalysis.Functions.md 'Atypical.TechnicalAnalysis.Functions')

## TechnicalAnalysis.Functions Assembly
531 changes: 375 additions & 156 deletions docs/links
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions src/TechnicalAnalysis.Candles/Candle2Crows/TACandle.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ public static partial class TACandle
/// <summary>
///
/// </summary>
/// <param name="startIdx"></param>
/// <param name="endIdx"></param>
/// <param name="startIdx">The start index.</param>
/// <param name="endIdx">The end index.</param>
/// <param name="open">An array of open prices.</param>
/// <param name="high">An array of high prices.</param>
/// <param name="low">An array of low prices.</param>
Expand Down
4 changes: 2 additions & 2 deletions src/TechnicalAnalysis.Candles/Candle3BlackCrows/TACandle.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ public static partial class TACandle
/// <summary>
///
/// </summary>
/// <param name="startIdx"></param>
/// <param name="endIdx"></param>
/// <param name="startIdx">The start index.</param>
/// <param name="endIdx">The end index.</param>
/// <param name="open">An array of open prices.</param>
/// <param name="high">An array of high prices.</param>
/// <param name="low">An array of low prices.</param>
Expand Down
4 changes: 2 additions & 2 deletions src/TechnicalAnalysis.Candles/Candle3Inside/TACandle.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ public static partial class TACandle
/// <summary>
///
/// </summary>
/// <param name="startIdx"></param>
/// <param name="endIdx"></param>
/// <param name="startIdx">The start index.</param>
/// <param name="endIdx">The end index.</param>
/// <param name="open">An array of open prices.</param>
/// <param name="high">An array of high prices.</param>
/// <param name="low">An array of low prices.</param>
Expand Down
4 changes: 2 additions & 2 deletions src/TechnicalAnalysis.Candles/Candle3LineStrike/TACandle.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ public static partial class TACandle
/// <summary>
///
/// </summary>
/// <param name="startIdx"></param>
/// <param name="endIdx"></param>
/// <param name="startIdx">The start index.</param>
/// <param name="endIdx">The end index.</param>
/// <param name="open">An array of open prices.</param>
/// <param name="high">An array of high prices.</param>
/// <param name="low">An array of low prices.</param>
Expand Down
4 changes: 2 additions & 2 deletions src/TechnicalAnalysis.Candles/Candle3Outside/TACandle.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ public static partial class TACandle
/// <summary>
///
/// </summary>
/// <param name="startIdx"></param>
/// <param name="endIdx"></param>
/// <param name="startIdx">The start index.</param>
/// <param name="endIdx">The end index.</param>
/// <param name="open">An array of open prices.</param>
/// <param name="high">An array of high prices.</param>
/// <param name="low">An array of low prices.</param>
Expand Down
4 changes: 2 additions & 2 deletions src/TechnicalAnalysis.Candles/Candle3StarsInSouth/TACandle.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ public static partial class TACandle
/// <summary>
///
/// </summary>
/// <param name="startIdx"></param>
/// <param name="endIdx"></param>
/// <param name="startIdx">The start index.</param>
/// <param name="endIdx">The end index.</param>
/// <param name="open">An array of open prices.</param>
/// <param name="high">An array of high prices.</param>
/// <param name="low">An array of low prices.</param>
Expand Down
4 changes: 2 additions & 2 deletions src/TechnicalAnalysis.Candles/Candle3WhiteSoldiers/TACandle.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ public static partial class TACandle
/// <summary>
///
/// </summary>
/// <param name="startIdx"></param>
/// <param name="endIdx"></param>
/// <param name="startIdx">The start index.</param>
/// <param name="endIdx">The end index.</param>
/// <param name="open">An array of open prices.</param>
/// <param name="high">An array of high prices.</param>
/// <param name="low">An array of low prices.</param>
Expand Down
8 changes: 4 additions & 4 deletions src/TechnicalAnalysis.Candles/CandleAbandonedBaby/TACandle.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ public static partial class TACandle
/// <summary>
///
/// </summary>
/// <param name="startIdx"></param>
/// <param name="endIdx"></param>
/// <param name="startIdx">The start index.</param>
/// <param name="endIdx">The end index.</param>
/// <param name="open">An array of open prices.</param>
/// <param name="high">An array of high prices.</param>
/// <param name="low">An array of low prices.</param>
Expand All @@ -31,8 +31,8 @@ public static CandleIndicatorResult CdlAbandonedBaby<T>(
/// <summary>
///
/// </summary>
/// <param name="startIdx"></param>
/// <param name="endIdx"></param>
/// <param name="startIdx">The start index.</param>
/// <param name="endIdx">The end index.</param>
/// <param name="open">An array of open prices.</param>
/// <param name="high">An array of high prices.</param>
/// <param name="low">An array of low prices.</param>
Expand Down
4 changes: 2 additions & 2 deletions src/TechnicalAnalysis.Candles/CandleAdvanceBlock/TACandle.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ public static partial class TACandle
/// <summary>
///
/// </summary>
/// <param name="startIdx"></param>
/// <param name="endIdx"></param>
/// <param name="startIdx">The start index.</param>
/// <param name="endIdx">The end index.</param>
/// <param name="open">An array of open prices.</param>
/// <param name="high">An array of high prices.</param>
/// <param name="low">An array of low prices.</param>
Expand Down
4 changes: 2 additions & 2 deletions src/TechnicalAnalysis.Candles/CandleBeltHold/TACandle.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ public static partial class TACandle
/// <summary>
///
/// </summary>
/// <param name="startIdx"></param>
/// <param name="endIdx"></param>
/// <param name="startIdx">The start index.</param>
/// <param name="endIdx">The end index.</param>
/// <param name="open">An array of open prices.</param>
/// <param name="high">An array of high prices.</param>
/// <param name="low">An array of low prices.</param>
Expand Down
4 changes: 2 additions & 2 deletions src/TechnicalAnalysis.Candles/CandleBreakaway/TACandle.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ public static partial class TACandle
/// <summary>
///
/// </summary>
/// <param name="startIdx"></param>
/// <param name="endIdx"></param>
/// <param name="startIdx">The start index.</param>
/// <param name="endIdx">The end index.</param>
/// <param name="open">An array of open prices.</param>
/// <param name="high">An array of high prices.</param>
/// <param name="low">An array of low prices.</param>
Expand Down
6 changes: 3 additions & 3 deletions src/TechnicalAnalysis.Candles/CandleClosingMarubozu/TACandle.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ public static partial class TACandle
/// <summary>
///
/// </summary>
/// <param name="startIdx"></param>
/// <param name="endIdx"></param>
/// <param name="startIdx">The start index.</param>
/// <param name="endIdx">The end index.</param>
/// <param name="open">An array of open prices.</param>
/// <param name="high">An array of high prices.</param>
/// <param name="low">An array of low prices.</param>
/// <param name="close">An array of close prices.</param>
/// <typeparam name="T"></typeparam>
/// <typeparam name="T">The type of the array elements.</typeparam>
/// <returns></returns>
public static CandleIndicatorResult CdlClosingMarubozu<T>(
int startIdx, int endIdx, T[] open, T[] high, T[] low, T[] close)
Expand Down
4 changes: 2 additions & 2 deletions src/TechnicalAnalysis.Candles/CandleConcealBabySwallow/TACandle.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ public static partial class TACandle
/// <summary>
///
/// </summary>
/// <param name="startIdx"></param>
/// <param name="endIdx"></param>
/// <param name="startIdx">The start index.</param>
/// <param name="endIdx">The end index.</param>
/// <param name="open">An array of open prices.</param>
/// <param name="high">An array of high prices.</param>
/// <param name="low">An array of low prices.</param>
Expand Down
4 changes: 2 additions & 2 deletions src/TechnicalAnalysis.Candles/CandleCounterAttack/TACandle.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ public static partial class TACandle
/// <summary>
///
/// </summary>
/// <param name="startIdx"></param>
/// <param name="endIdx"></param>
/// <param name="startIdx">The start index.</param>
/// <param name="endIdx">The end index.</param>
/// <param name="open">An array of open prices.</param>
/// <param name="high">An array of high prices.</param>
/// <param name="low">An array of low prices.</param>
Expand Down
12 changes: 6 additions & 6 deletions src/TechnicalAnalysis.Candles/CandleDarkCloudCover/TACandle.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ public static partial class TACandle
/// <summary>
///
/// </summary>
/// <param name="startIdx"></param>
/// <param name="endIdx"></param>
/// <param name="startIdx">The start index.</param>
/// <param name="endIdx">The end index.</param>
/// <param name="open">An array of open prices.</param>
/// <param name="high">An array of high prices.</param>
/// <param name="low">An array of low prices.</param>
/// <param name="close">An array of close prices.</param>
/// <param name="penetration"></param>
/// <typeparam name="T"></typeparam>
/// <typeparam name="T">The type of the array elements.</typeparam>
/// <returns></returns>
public static CandleIndicatorResult CdlDarkCloudCover<T>(
int startIdx, int endIdx, T[] open, T[] high, T[] low, T[] close, T penetration)
Expand All @@ -31,13 +31,13 @@ public static CandleIndicatorResult CdlDarkCloudCover<T>(
/// <summary>
///
/// </summary>
/// <param name="startIdx"></param>
/// <param name="endIdx"></param>
/// <param name="startIdx">The start index.</param>
/// <param name="endIdx">The end index.</param>
/// <param name="open">An array of open prices.</param>
/// <param name="high">An array of high prices.</param>
/// <param name="low">An array of low prices.</param>
/// <param name="close">An array of close prices.</param>
/// <typeparam name="T"></typeparam>
/// <typeparam name="T">The type of the array elements.</typeparam>
/// <returns></returns>
public static CandleIndicatorResult CdlDarkCloudCover<T>(
int startIdx, int endIdx, T[] open, T[] high, T[] low, T[] close)
Expand Down
4 changes: 2 additions & 2 deletions src/TechnicalAnalysis.Candles/CandleDoji/TACandle.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ public static partial class TACandle
/// <summary>
///
/// </summary>
/// <param name="startIdx"></param>
/// <param name="endIdx"></param>
/// <param name="startIdx">The start index.</param>
/// <param name="endIdx">The end index.</param>
/// <param name="open">An array of open prices.</param>
/// <param name="high">An array of high prices.</param>
/// <param name="low">An array of low prices.</param>
Expand Down
4 changes: 2 additions & 2 deletions src/TechnicalAnalysis.Candles/CandleDojiStar/TACandle.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ public static partial class TACandle
/// <summary>
///
/// </summary>
/// <param name="startIdx"></param>
/// <param name="endIdx"></param>
/// <param name="startIdx">The start index.</param>
/// <param name="endIdx">The end index.</param>
/// <param name="open">An array of open prices.</param>
/// <param name="high">An array of high prices.</param>
/// <param name="low">An array of low prices.</param>
Expand Down
4 changes: 2 additions & 2 deletions src/TechnicalAnalysis.Candles/CandleDragonflyDoji/TACandle.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ public static partial class TACandle
/// <summary>
///
/// </summary>
/// <param name="startIdx"></param>
/// <param name="endIdx"></param>
/// <param name="startIdx">The start index.</param>
/// <param name="endIdx">The end index.</param>
/// <param name="open">An array of open prices.</param>
/// <param name="high">An array of high prices.</param>
/// <param name="low">An array of low prices.</param>
Expand Down
4 changes: 2 additions & 2 deletions src/TechnicalAnalysis.Candles/CandleEngulfing/TACandle.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ public static partial class TACandle
/// <summary>
///
/// </summary>
/// <param name="startIdx"></param>
/// <param name="endIdx"></param>
/// <param name="startIdx">The start index.</param>
/// <param name="endIdx">The end index.</param>
/// <param name="open">An array of open prices.</param>
/// <param name="high">An array of high prices.</param>
/// <param name="low">An array of low prices.</param>
Expand Down
8 changes: 4 additions & 4 deletions src/TechnicalAnalysis.Candles/CandleEveningDojiStar/TACandle.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ public static partial class TACandle
/// <summary>
///
/// </summary>
/// <param name="startIdx"></param>
/// <param name="endIdx"></param>
/// <param name="startIdx">The start index.</param>
/// <param name="endIdx">The end index.</param>
/// <param name="open">An array of open prices.</param>
/// <param name="high">An array of high prices.</param>
/// <param name="low">An array of low prices.</param>
Expand All @@ -31,8 +31,8 @@ public static CandleIndicatorResult CdlEveningDojiStar<T>(
/// <summary>
///
/// </summary>
/// <param name="startIdx"></param>
/// <param name="endIdx"></param>
/// <param name="startIdx">The start index.</param>
/// <param name="endIdx">The end index.</param>
/// <param name="open">An array of open prices.</param>
/// <param name="high">An array of high prices.</param>
/// <param name="low">An array of low prices.</param>
Expand Down
8 changes: 4 additions & 4 deletions src/TechnicalAnalysis.Candles/CandleEveningStar/TACandle.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ public static partial class TACandle
/// <summary>
///
/// </summary>
/// <param name="startIdx"></param>
/// <param name="endIdx"></param>
/// <param name="startIdx">The start index.</param>
/// <param name="endIdx">The end index.</param>
/// <param name="open">An array of open prices.</param>
/// <param name="high">An array of high prices.</param>
/// <param name="low">An array of low prices.</param>
Expand All @@ -31,8 +31,8 @@ public static CandleIndicatorResult CdlEveningStar<T>(
/// <summary>
///
/// </summary>
/// <param name="startIdx"></param>
/// <param name="endIdx"></param>
/// <param name="startIdx">The start index.</param>
/// <param name="endIdx">The end index.</param>
/// <param name="open">An array of open prices.</param>
/// <param name="high">An array of high prices.</param>
/// <param name="low">An array of low prices.</param>
Expand Down
4 changes: 2 additions & 2 deletions src/TechnicalAnalysis.Candles/CandleGapSideSideWhite/TACandle.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ public static partial class TACandle
/// <summary>
///
/// </summary>
/// <param name="startIdx"></param>
/// <param name="endIdx"></param>
/// <param name="startIdx">The start index.</param>
/// <param name="endIdx">The end index.</param>
/// <param name="open">An array of open prices.</param>
/// <param name="high">An array of high prices.</param>
/// <param name="low">An array of low prices.</param>
Expand Down
4 changes: 2 additions & 2 deletions src/TechnicalAnalysis.Candles/CandleGravestoneDoji/TACandle.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ public static partial class TACandle
/// <summary>
///
/// </summary>
/// <param name="startIdx"></param>
/// <param name="endIdx"></param>
/// <param name="startIdx">The start index.</param>
/// <param name="endIdx">The end index.</param>
/// <param name="open">An array of open prices.</param>
/// <param name="high">An array of high prices.</param>
/// <param name="low">An array of low prices.</param>
Expand Down
6 changes: 3 additions & 3 deletions src/TechnicalAnalysis.Candles/CandleHammer/TACandle.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ public static partial class TACandle
/// <summary>
///
/// </summary>
/// <param name="startIdx"></param>
/// <param name="endIdx"></param>
/// <param name="startIdx">The start index.</param>
/// <param name="endIdx">The end index.</param>
/// <param name="open">An array of open prices.</param>
/// <param name="high">An array of high prices.</param>
/// <param name="low">An array of low prices.</param>
/// <param name="close">An array of close prices.</param>
/// <typeparam name="T"></typeparam>
/// <typeparam name="T">The type of the array elements.</typeparam>
/// <returns></returns>
public static CandleIndicatorResult CdlHammer<T>(
int startIdx, int endIdx, T[] open, T[] high, T[] low, T[] close)
Expand Down
4 changes: 2 additions & 2 deletions src/TechnicalAnalysis.Candles/CandleHangingMan/TACandle.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ public static partial class TACandle
/// <summary>
///
/// </summary>
/// <param name="startIdx"></param>
/// <param name="endIdx"></param>
/// <param name="startIdx">The start index.</param>
/// <param name="endIdx">The end index.</param>
/// <param name="open">An array of open prices.</param>
/// <param name="high">An array of high prices.</param>
/// <param name="low">An array of low prices.</param>
Expand Down
4 changes: 2 additions & 2 deletions src/TechnicalAnalysis.Candles/CandleHarami/TACandle.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ public static partial class TACandle
/// <summary>
///
/// </summary>
/// <param name="startIdx"></param>
/// <param name="endIdx"></param>
/// <param name="startIdx">The start index.</param>
/// <param name="endIdx">The end index.</param>
/// <param name="open">An array of open prices.</param>
/// <param name="high">An array of high prices.</param>
/// <param name="low">An array of low prices.</param>
Expand Down
4 changes: 2 additions & 2 deletions src/TechnicalAnalysis.Candles/CandleHaramiCross/TACandle.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ public static partial class TACandle
/// <summary>
///
/// </summary>
/// <param name="startIdx"></param>
/// <param name="endIdx"></param>
/// <param name="startIdx">The start index.</param>
/// <param name="endIdx">The end index.</param>
/// <param name="open">An array of open prices.</param>
/// <param name="high">An array of high prices.</param>
/// <param name="low">An array of low prices.</param>
Expand Down
4 changes: 2 additions & 2 deletions src/TechnicalAnalysis.Candles/CandleHighWave/TACandle.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ public static partial class TACandle
/// <summary>
///
/// </summary>
/// <param name="startIdx"></param>
/// <param name="endIdx"></param>
/// <param name="startIdx">The start index.</param>
/// <param name="endIdx">The end index.</param>
/// <param name="open">An array of open prices.</param>
/// <param name="high">An array of high prices.</param>
/// <param name="low">An array of low prices.</param>
Expand Down
4 changes: 2 additions & 2 deletions src/TechnicalAnalysis.Candles/CandleHikkake/TACandle.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ public static partial class TACandle
/// <summary>
///
/// </summary>
/// <param name="startIdx"></param>
/// <param name="endIdx"></param>
/// <param name="startIdx">The start index.</param>
/// <param name="endIdx">The end index.</param>
/// <param name="open">An array of open prices.</param>
/// <param name="high">An array of high prices.</param>
/// <param name="low">An array of low prices.</param>
Expand Down
Loading

0 comments on commit 767f1d9

Please sign in to comment.