From e62a41983a67c7d3fcfba60e7ddda876c6696118 Mon Sep 17 00:00:00 2001 From: Mingwei Samuel Date: Tue, 22 Oct 2019 18:21:27 -0700 Subject: [PATCH] adding champion docs --- src/consts/champion.rs | 298 ++++++++++++++++++----------------- src/endpoints.rs | 2 +- src/endpoints/dto.rs | 2 +- srcgen/consts/champion.rs.dt | 12 +- 4 files changed, 162 insertions(+), 152 deletions(-) diff --git a/src/consts/champion.rs b/src/consts/champion.rs index b91d8fb..0bc36be 100644 --- a/src/consts/champion.rs +++ b/src/consts/champion.rs @@ -1,160 +1,164 @@  // This file is automatically generated. // Do not directly edit. -// Generated on 2019-10-22T21:22:55.963Z +// Generated on 2019-10-22T21:42:10.101Z use std::fmt; use num_derive; +/// League of Legend's champions. +/// +/// The documentation of each variant specifies:
+/// NAME (`IDENTIFIER`, ID). #[derive(fmt::Debug, Copy, Clone)] #[derive(num_derive::FromPrimitive, num_derive::ToPrimitive)] pub enum Champion { - Aatrox = 266, - Ahri = 103, - Akali = 84, - Alistar = 12, - Amumu = 32, - Anivia = 34, - Annie = 1, - Ashe = 22, - AurelionSol = 136, - Azir = 268, - Bard = 432, - Blitzcrank = 53, - Brand = 63, - Braum = 201, - Caitlyn = 51, - Camille = 164, - Cassiopeia = 69, - ChoGath = 31, - Corki = 42, - Darius = 122, - Diana = 131, - DrMundo = 36, - Draven = 119, - Ekko = 245, - Elise = 60, - Evelynn = 28, - Ezreal = 81, - Fiddlesticks = 9, - Fiora = 114, - Fizz = 105, - Galio = 3, - Gangplank = 41, - Garen = 86, - Gnar = 150, - Gragas = 79, - Graves = 104, - Hecarim = 120, - Heimerdinger = 74, - Illaoi = 420, - Irelia = 39, - Ivern = 427, - Janna = 40, - JarvanIV = 59, - Jax = 24, - Jayce = 126, - Jhin = 202, - Jinx = 222, - KaiSa = 145, - Kalista = 429, - Karma = 43, - Karthus = 30, - Kassadin = 38, - Katarina = 55, - Kayle = 10, - Kayn = 141, - Kennen = 85, - KhaZix = 121, - Kindred = 203, - Kled = 240, - KogMaw = 96, - LeBlanc = 7, - LeeSin = 64, - Leona = 89, - Lissandra = 127, - Lucian = 236, - Lulu = 117, - Lux = 99, - Malphite = 54, - Malzahar = 90, - Maokai = 57, - MasterYi = 11, - MissFortune = 21, - Mordekaiser = 82, - Morgana = 25, - Nami = 267, - Nasus = 75, - Nautilus = 111, - Neeko = 518, - Nidalee = 76, - Nocturne = 56, - NunuWillump = 20, - Olaf = 2, - Orianna = 61, - Ornn = 516, - Pantheon = 80, - Poppy = 78, - Pyke = 555, - Qiyana = 246, - Quinn = 133, - Rakan = 497, - Rammus = 33, - RekSai = 421, - Renekton = 58, - Rengar = 107, - Riven = 92, - Rumble = 68, - Ryze = 13, - Sejuani = 113, - Shaco = 35, - Shen = 98, - Shyvana = 102, - Singed = 27, - Sion = 14, - Sivir = 15, - Skarner = 72, - Sona = 37, - Soraka = 16, - Swain = 50, - Sylas = 517, - Syndra = 134, - TahmKench = 223, - Taliyah = 163, - Talon = 91, - Taric = 44, - Teemo = 17, - Thresh = 412, - Tristana = 18, - Trundle = 48, - Tryndamere = 23, - TwistedFate = 4, - Twitch = 29, - Udyr = 77, - Urgot = 6, - Varus = 110, - Vayne = 67, - Veigar = 45, - VelKoz = 161, - Vi = 254, - Viktor = 112, - Vladimir = 8, - Volibear = 106, - Warwick = 19, - Wukong = 62, - Xayah = 498, - Xerath = 101, - XinZhao = 5, - Yasuo = 157, - Yorick = 83, - Yuumi = 350, - Zac = 154, - Zed = 238, - Ziggs = 115, - Zilean = 26, - Zoe = 142, - Zyra = 143, - } + /** Aatrox (`Aatrox`, 266). */ Aatrox = 266, + /** Ahri (`Ahri`, 103). */ Ahri = 103, + /** Akali (`Akali`, 84). */ Akali = 84, + /** Alistar (`Alistar`, 12). */ Alistar = 12, + /** Amumu (`Amumu`, 32). */ Amumu = 32, + /** Anivia (`Anivia`, 34). */ Anivia = 34, + /** Annie (`Annie`, 1). */ Annie = 1, + /** Ashe (`Ashe`, 22). */ Ashe = 22, + /** Aurelion Sol (`AurelionSol`, 136). */ AurelionSol = 136, + /** Azir (`Azir`, 268). */ Azir = 268, + /** Bard (`Bard`, 432). */ Bard = 432, + /** Blitzcrank (`Blitzcrank`, 53). */ Blitzcrank = 53, + /** Brand (`Brand`, 63). */ Brand = 63, + /** Braum (`Braum`, 201). */ Braum = 201, + /** Caitlyn (`Caitlyn`, 51). */ Caitlyn = 51, + /** Camille (`Camille`, 164). */ Camille = 164, + /** Cassiopeia (`Cassiopeia`, 69). */ Cassiopeia = 69, + /** Cho'Gath (`Chogath`, 31). */ ChoGath = 31, + /** Corki (`Corki`, 42). */ Corki = 42, + /** Darius (`Darius`, 122). */ Darius = 122, + /** Diana (`Diana`, 131). */ Diana = 131, + /** Dr. Mundo (`DrMundo`, 36). */ DrMundo = 36, + /** Draven (`Draven`, 119). */ Draven = 119, + /** Ekko (`Ekko`, 245). */ Ekko = 245, + /** Elise (`Elise`, 60). */ Elise = 60, + /** Evelynn (`Evelynn`, 28). */ Evelynn = 28, + /** Ezreal (`Ezreal`, 81). */ Ezreal = 81, + /** Fiddlesticks (`FiddleSticks`, 9). */ Fiddlesticks = 9, + /** Fiora (`Fiora`, 114). */ Fiora = 114, + /** Fizz (`Fizz`, 105). */ Fizz = 105, + /** Galio (`Galio`, 3). */ Galio = 3, + /** Gangplank (`Gangplank`, 41). */ Gangplank = 41, + /** Garen (`Garen`, 86). */ Garen = 86, + /** Gnar (`Gnar`, 150). */ Gnar = 150, + /** Gragas (`Gragas`, 79). */ Gragas = 79, + /** Graves (`Graves`, 104). */ Graves = 104, + /** Hecarim (`Hecarim`, 120). */ Hecarim = 120, + /** Heimerdinger (`Heimerdinger`, 74). */ Heimerdinger = 74, + /** Illaoi (`Illaoi`, 420). */ Illaoi = 420, + /** Irelia (`Irelia`, 39). */ Irelia = 39, + /** Ivern (`Ivern`, 427). */ Ivern = 427, + /** Janna (`Janna`, 40). */ Janna = 40, + /** Jarvan IV (`JarvanIV`, 59). */ JarvanIV = 59, + /** Jax (`Jax`, 24). */ Jax = 24, + /** Jayce (`Jayce`, 126). */ Jayce = 126, + /** Jhin (`Jhin`, 202). */ Jhin = 202, + /** Jinx (`Jinx`, 222). */ Jinx = 222, + /** Kai'Sa (`Kaisa`, 145). */ KaiSa = 145, + /** Kalista (`Kalista`, 429). */ Kalista = 429, + /** Karma (`Karma`, 43). */ Karma = 43, + /** Karthus (`Karthus`, 30). */ Karthus = 30, + /** Kassadin (`Kassadin`, 38). */ Kassadin = 38, + /** Katarina (`Katarina`, 55). */ Katarina = 55, + /** Kayle (`Kayle`, 10). */ Kayle = 10, + /** Kayn (`Kayn`, 141). */ Kayn = 141, + /** Kennen (`Kennen`, 85). */ Kennen = 85, + /** Kha'Zix (`Khazix`, 121). */ KhaZix = 121, + /** Kindred (`Kindred`, 203). */ Kindred = 203, + /** Kled (`Kled`, 240). */ Kled = 240, + /** Kog'Maw (`KogMaw`, 96). */ KogMaw = 96, + /** LeBlanc (`Leblanc`, 7). */ LeBlanc = 7, + /** Lee Sin (`LeeSin`, 64). */ LeeSin = 64, + /** Leona (`Leona`, 89). */ Leona = 89, + /** Lissandra (`Lissandra`, 127). */ Lissandra = 127, + /** Lucian (`Lucian`, 236). */ Lucian = 236, + /** Lulu (`Lulu`, 117). */ Lulu = 117, + /** Lux (`Lux`, 99). */ Lux = 99, + /** Malphite (`Malphite`, 54). */ Malphite = 54, + /** Malzahar (`Malzahar`, 90). */ Malzahar = 90, + /** Maokai (`Maokai`, 57). */ Maokai = 57, + /** Master Yi (`MasterYi`, 11). */ MasterYi = 11, + /** Miss Fortune (`MissFortune`, 21). */ MissFortune = 21, + /** Mordekaiser (`Mordekaiser`, 82). */ Mordekaiser = 82, + /** Morgana (`Morgana`, 25). */ Morgana = 25, + /** Nami (`Nami`, 267). */ Nami = 267, + /** Nasus (`Nasus`, 75). */ Nasus = 75, + /** Nautilus (`Nautilus`, 111). */ Nautilus = 111, + /** Neeko (`Neeko`, 518). */ Neeko = 518, + /** Nidalee (`Nidalee`, 76). */ Nidalee = 76, + /** Nocturne (`Nocturne`, 56). */ Nocturne = 56, + /** Nunu & Willump (`Nunu`, 20). */ NunuWillump = 20, + /** Olaf (`Olaf`, 2). */ Olaf = 2, + /** Orianna (`Orianna`, 61). */ Orianna = 61, + /** Ornn (`Ornn`, 516). */ Ornn = 516, + /** Pantheon (`Pantheon`, 80). */ Pantheon = 80, + /** Poppy (`Poppy`, 78). */ Poppy = 78, + /** Pyke (`Pyke`, 555). */ Pyke = 555, + /** Qiyana (`Qiyana`, 246). */ Qiyana = 246, + /** Quinn (`Quinn`, 133). */ Quinn = 133, + /** Rakan (`Rakan`, 497). */ Rakan = 497, + /** Rammus (`Rammus`, 33). */ Rammus = 33, + /** Rek'Sai (`RekSai`, 421). */ RekSai = 421, + /** Renekton (`Renekton`, 58). */ Renekton = 58, + /** Rengar (`Rengar`, 107). */ Rengar = 107, + /** Riven (`Riven`, 92). */ Riven = 92, + /** Rumble (`Rumble`, 68). */ Rumble = 68, + /** Ryze (`Ryze`, 13). */ Ryze = 13, + /** Sejuani (`Sejuani`, 113). */ Sejuani = 113, + /** Shaco (`Shaco`, 35). */ Shaco = 35, + /** Shen (`Shen`, 98). */ Shen = 98, + /** Shyvana (`Shyvana`, 102). */ Shyvana = 102, + /** Singed (`Singed`, 27). */ Singed = 27, + /** Sion (`Sion`, 14). */ Sion = 14, + /** Sivir (`Sivir`, 15). */ Sivir = 15, + /** Skarner (`Skarner`, 72). */ Skarner = 72, + /** Sona (`Sona`, 37). */ Sona = 37, + /** Soraka (`Soraka`, 16). */ Soraka = 16, + /** Swain (`Swain`, 50). */ Swain = 50, + /** Sylas (`Sylas`, 517). */ Sylas = 517, + /** Syndra (`Syndra`, 134). */ Syndra = 134, + /** Tahm Kench (`TahmKench`, 223). */ TahmKench = 223, + /** Taliyah (`Taliyah`, 163). */ Taliyah = 163, + /** Talon (`Talon`, 91). */ Talon = 91, + /** Taric (`Taric`, 44). */ Taric = 44, + /** Teemo (`Teemo`, 17). */ Teemo = 17, + /** Thresh (`Thresh`, 412). */ Thresh = 412, + /** Tristana (`Tristana`, 18). */ Tristana = 18, + /** Trundle (`Trundle`, 48). */ Trundle = 48, + /** Tryndamere (`Tryndamere`, 23). */ Tryndamere = 23, + /** Twisted Fate (`TwistedFate`, 4). */ TwistedFate = 4, + /** Twitch (`Twitch`, 29). */ Twitch = 29, + /** Udyr (`Udyr`, 77). */ Udyr = 77, + /** Urgot (`Urgot`, 6). */ Urgot = 6, + /** Varus (`Varus`, 110). */ Varus = 110, + /** Vayne (`Vayne`, 67). */ Vayne = 67, + /** Veigar (`Veigar`, 45). */ Veigar = 45, + /** Vel'Koz (`Velkoz`, 161). */ VelKoz = 161, + /** Vi (`Vi`, 254). */ Vi = 254, + /** Viktor (`Viktor`, 112). */ Viktor = 112, + /** Vladimir (`Vladimir`, 8). */ Vladimir = 8, + /** Volibear (`Volibear`, 106). */ Volibear = 106, + /** Warwick (`Warwick`, 19). */ Warwick = 19, + /** Wukong (`MonkeyKing`, 62). */ Wukong = 62, + /** Xayah (`Xayah`, 498). */ Xayah = 498, + /** Xerath (`Xerath`, 101). */ Xerath = 101, + /** Xin Zhao (`XinZhao`, 5). */ XinZhao = 5, + /** Yasuo (`Yasuo`, 157). */ Yasuo = 157, + /** Yorick (`Yorick`, 83). */ Yorick = 83, + /** Yuumi (`Yuumi`, 350). */ Yuumi = 350, + /** Zac (`Zac`, 154). */ Zac = 154, + /** Zed (`Zed`, 238). */ Zed = 238, + /** Ziggs (`Ziggs`, 115). */ Ziggs = 115, + /** Zilean (`Zilean`, 26). */ Zilean = 26, + /** Zoe (`Zoe`, 142). */ Zoe = 142, + /** Zyra (`Zyra`, 143). */ Zyra = 143, +} impl Champion { pub fn name(self) -> &'static str { diff --git a/src/endpoints.rs b/src/endpoints.rs index 35b7e72..fbd9f34 100644 --- a/src/endpoints.rs +++ b/src/endpoints.rs @@ -1,7 +1,7 @@ // This file is automatically generated. // Do not directly edit. -// Generated on 2019-10-22T21:22:55.948Z +// Generated on 2019-10-22T21:42:10.216Z // http://www.mingweisamuel.com/riotapi-schema/tool/ // Version 0c74167e0eaaeb6de1c7e8219fecaabcf8386d1f diff --git a/src/endpoints/dto.rs b/src/endpoints/dto.rs index b7ab291..fa14542 100644 --- a/src/endpoints/dto.rs +++ b/src/endpoints/dto.rs @@ -1,7 +1,7 @@ // This file is automatically generated. // Do not directly edit. -// Generated on 2019-10-22T21:22:55.955Z +// Generated on 2019-10-22T21:42:10.207Z // http://www.mingweisamuel.com/riotapi-schema/tool/ // Version 0c74167e0eaaeb6de1c7e8219fecaabcf8386d1f diff --git a/srcgen/consts/champion.rs.dt b/srcgen/consts/champion.rs.dt index d176ee7..c74ae3a 100644 --- a/srcgen/consts/champion.rs.dt +++ b/srcgen/consts/champion.rs.dt @@ -19,17 +19,23 @@ use std::fmt; use num_derive; +/// League of Legend's champions. +/// +/// The documentation of each variant specifies:
+/// NAME (`IDENTIFIER`, ID). #[derive(fmt::Debug, Copy, Clone)] #[derive(num_derive::FromPrimitive, num_derive::ToPrimitive)] pub enum Champion { {{ - for (let { id, name } of champions) { + for (let { id, alias, name } of champions) { + const comment = `${name.padEnd(14)} (\`${alias}\`, ${id}).`.padEnd(36); + const ename = enumName(name).padEnd(12); }} - {{= enumName(name).padEnd(12) }} = {{= id }}, + /** {{= comment }} */ {{= ename }} = {{= id }}, {{ } }} - } +} impl Champion { pub fn name(self) -> &'static str {