AP_Terrain: update comments for height_terrain_difference_home

This commit is contained in:
Randy Mackay 2016-04-27 19:05:02 +09:00
parent d84321be2e
commit 83922f9b65
1 changed files with 7 additions and 4 deletions

View File

@ -157,12 +157,15 @@ bool AP_Terrain::height_amsl(const Location &loc, float &height, bool corrected)
/*
find difference between home terrain height and the terrain height
at a given location, in meters. A positive result means the terrain
is higher than home.
find difference between home terrain height and the terrain
height at the current location in meters. A positive result
means the terrain is higher than home.
return false is terrain at the given location or at home
return false is terrain at the current location or at home
location is not available
If extrapolate is true then allow return of an extrapolated
terrain altitude based on the last available data
*/
bool AP_Terrain::height_terrain_difference_home(float &terrain_difference, bool extrapolate)
{