@@ -55,7 +55,6 @@ FlightLog = {
5555--
5656-- text - Text to accompany the log
5757--
58-
5958 MakeCustomEntry = function (text )
6059 text = text or " "
6160 local location = " "
@@ -97,18 +96,29 @@ FlightLog = {
9796}
9897
9998
100- --- Method: GetLogEntries
101- --- @param types table[string,boolean] | nil Keys are log types to include , set the boolean to true for the ones you want
102- --- @param maximum integer | nil Maximum number of entries to include
103- --- @param earliest_first boolean | nil Should the log start with the oldest entry or the most recent
99+ -- Method: GetLogEntries
100+ --
101+ -- Example:
102+ --
103+ -- > for entry in FlightLog.GetLogEntries( { "Custom", "System", "Station" ) do
104+ -- > print( entry.GetType(), entry.entry )
105+ -- > end
106+ --
107+ -- Parameters:
108+ --
109+ -- types - A table where keys are log types to include and the value is a boolean, set to true to include that type
110+ -- maximum - An optional integer, with the maximum number of entries to include
111+ -- earliest_first - An optional boolean to say if the log should be ordered in chronological order or reverse chronological order
112+ --
113+ -- Returns:
114+ --
115+ -- An iterator function that when called repeatedly returns the next entry or nil when complete
116+ --
117+ --- @param types table<string,boolean> ?
118+ --- @param maximum integer ?
119+ --- @param earliest_first boolean ?
104120---
105- --- @return function (): FlightLogEntry.Base An iterator function that when called repeatedly returns the next entry or nil when complete
106- ---
107- --- Example:
108- ---
109- --- > for entry in FlightLog.GetLogEntries( { "Custom", "System", "Station" ) do
110- --- > print( entry.GetType(), entry.entry )
111- --- > end
121+ --- @return fun (): FlightLogEntry.Base
112122function FlightLog :GetLogEntries (types , maximum , earliest_first )
113123
114124 local counter = 0
0 commit comments