123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880 |
- <?xml version="1.0"?>
- <doc>
- <assembly>
- <name>NAnt.Core</name>
- </assembly>
- <members>
- <member name="T:NAnt.Core.Attributes.BooleanValidatorAttribute">
- <summary>
- Used to indicate that a property should be able to be converted into a
- <see cref="T:System.Boolean"/>.
- </summary>
- </member>
- <member name="T:NAnt.Core.Attributes.ValidatorAttribute">
- <summary>
- Base class for all validator attributes.
- </summary>
- </member>
- <member name="M:NAnt.Core.Attributes.ValidatorAttribute.Validate(System.Object)">
- <summary>
- Validates the specified value.
- </summary>
- <param name="value">The value to be validated.</param>
- <exception cref="T:NAnt.Core.ValidationException">The validation fails.</exception>
- </member>
- <member name="M:NAnt.Core.Attributes.BooleanValidatorAttribute.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.BooleanValidatorAttribute"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Attributes.BooleanValidatorAttribute.Validate(System.Object)">
- <summary>
- Checks if the specified value can be converted to a <see cref="T:System.Boolean"/>.
- </summary>
- <param name="value">The value to be checked.</param>
- <exception cref="T:NAnt.Core.ValidationException"><paramref name="value"/> cannot be converted to a <see cref="T:System.Boolean"/>.</exception>
- </member>
- <member name="T:NAnt.Core.Attributes.BuildAttributeAttribute">
- <summary>
- Indicates that property should be treated as a XML attribute for the
- task.
- </summary>
- <example>
- Examples of how to specify task attributes
- <code>
- #region Public Instance Properties
-
- [BuildAttribute("out", Required=true)]
- public string Output {
- get { return _out; }
- set { _out = value; }
- }
-
- [BuildAttribute("optimize")]
- [BooleanValidator()]
- public bool Optimize {
- get { return _optimize; }
- set { _optimize = value; }
- }
-
- [BuildAttribute("warnlevel")]
- [Int32Validator(0,4)] // limit values to 0-4
- public int WarnLevel {
- get { return _warnLevel; }
- set { _warnLevel = value; }
- }
-
- [BuildElement("sources")]
- public FileSet Sources {
- get { return _sources; }
- set { _sources = value; }
- }
-
- #endregion Public Instance Properties
-
- #region Private Instance Fields
-
- private string _out = null;
- private bool _optimize = false;
- private int _warnLevel = 4;
- private FileSet _sources = new FileSet();
-
- #endregion Private Instance Fields
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Attributes.BuildAttributeAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.BuildAttributeAttribute"/> with the
- specified name.
- </summary>
- <param name="name">The name of the attribute.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
- </member>
- <member name="P:NAnt.Core.Attributes.BuildAttributeAttribute.Name">
- <summary>
- Gets or sets the name of the XML attribute.
- </summary>
- <value>
- The name of the XML attribute.
- </value>
- </member>
- <member name="P:NAnt.Core.Attributes.BuildAttributeAttribute.Required">
- <summary>
- Gets or sets a value indicating whether the attribute is required.
- </summary>
- <value>
- <see langword="true" /> if the attribute is required; otherwise,
- <see langword="false" />. The default is <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.Attributes.BuildAttributeAttribute.ExpandProperties">
- <summary>
- Gets or sets a value indicating whether property references should
- be expanded.
- </summary>
- <value>
- <see langword="true" /> if properties should be expanded; otherwise
- <see langword="false" />. The default is <see langword="true" />.
- </value>
- </member>
- <member name="P:NAnt.Core.Attributes.BuildAttributeAttribute.ProcessXml">
- <summary>
- Used to specify how this attribute will be handled as the XML is
- parsed and given to the element.
- </summary>
- <value>
- <see langword="true" /> if XML should be processed; otherwise
- <see langword="false" />. The default is <see langword="true" />.
- </value>
- </member>
- <member name="T:NAnt.Core.Attributes.BuildElementArrayAttribute">
- <summary>
- Indicates that property should be treated as a XML arrayList
- </summary>
- <remarks>
- <para>
- Should only be applied to properties exposing strongly typed arrays or
- strongly typed collections.
- </para>
- <para>
- The XML format is like this:
- <code>
- <![CDATA[
- <task>
- <elementName ... />
- <elementName ... />
- <elementName ... />
- <elementName ... />
- </task>
- ]]>
- </code>
- </para>
- </remarks>
- </member>
- <member name="T:NAnt.Core.Attributes.BuildElementAttribute">
- <summary>
- Indicates that the property should be treated as an XML element and
- further processing should be done.
- </summary>
- <remarks>
- <para>
- Should only be applied to properties exposing strongly typed arrays or
- strongly typed collections.
- </para>
- <para>
- The XML format is like this:
- <code>
- <![CDATA[
- <task>
- <elementName ...>
- <morestuff />
- </elementName>
- </task>
- ]]>
- </code>
- </para>
- </remarks>
- </member>
- <member name="M:NAnt.Core.Attributes.BuildElementAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.BuildElementAttribute"/> with the
- specified name.
- </summary>
- <param name="name">The name of the attribute.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
- </member>
- <member name="P:NAnt.Core.Attributes.BuildElementAttribute.Name">
- <summary>
- Gets or sets the name of the attribute.
- </summary>
- <value>
- The name of the attribute.
- </value>
- </member>
- <member name="P:NAnt.Core.Attributes.BuildElementAttribute.Required">
- <summary>
- Gets or sets a value indicating whether the attribute is required.
- </summary>
- <value>
- <see langword="true" /> if the attribute is required; otherwise,
- <see langword="false" />. The default is <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.Attributes.BuildElementAttribute.ProcessXml">
- <summary>
- Used to specify how this element will be handled as the XML is parsed
- and given to the element.
- </summary>
- <value>
- <see langword="true" /> if XML should be processed; otherwise
- <see langword="false" />. The default is <see langword="true" />.
- </value>
- </member>
- <member name="M:NAnt.Core.Attributes.BuildElementArrayAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.BuildElementArrayAttribute"/>
- with the specified name.
- </summary>
- <param name="name">The name of the attribute.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
- </member>
- <member name="P:NAnt.Core.Attributes.BuildElementArrayAttribute.ElementType">
- <summary>
- Gets or sets the type of objects that this container holds.
- </summary>
- <value>
- The type of the elements that this container holds.
- </value>
- <remarks>
- <para>
- This can be used for validation and schema generation.
- </para>
- <para>
- If not specified, the type of the elements will be determined using
- reflection.
- </para>
- </remarks>
- <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
- </member>
- <member name="T:NAnt.Core.Attributes.BuildElementCollectionAttribute">
- <summary>
- Indicates that the property should be treated as a container for a
- collection of build elements.
- </summary>
- <remarks>
- <para>
- Should only be applied to properties exposing strongly typed arrays or
- strongly typed collections.
- </para>
- <para>
- The XML format is like this:
- <code>
- <![CDATA[
- <task>
- <collectionName>
- <elementName ... />
- <elementName ... />
- <elementName ... />
- <elementName ... />
- </collectionName>
- </task>
- ]]>
- </code>
- </para>
- </remarks>
- </member>
- <member name="M:NAnt.Core.Attributes.BuildElementCollectionAttribute.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.BuildElementCollectionAttribute"/> with the
- specified name and child element name.
- </summary>
- <param name="collectionName">The name of the collection.</param>
- <param name="childName">The name of the child elements in the collection</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="childName"/> is <see langword="null"/>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="childName"/> is a zero-length <see cref="T:System.String"/>.</exception>
- </member>
- <member name="P:NAnt.Core.Attributes.BuildElementCollectionAttribute.ChildElementName">
- <summary>
- The name of the child element within the collection.
- </summary>
- <value>
- The name to check for in the XML of the elements in the collection.
- </value>
- <remarks>
- This can be used for validation and schema generation.
- </remarks>
- </member>
- <member name="T:NAnt.Core.Attributes.DateTimeValidatorAttribute">
- <summary>
- Used to indicate that a property should be able to be converted into a
- <see cref="T:System.DateTime"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Attributes.DateTimeValidatorAttribute.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.DateTimeValidatorAttribute"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Attributes.DateTimeValidatorAttribute.Validate(System.Object)">
- <summary>
- Checks if the specified value can be converted to a <see cref="T:System.DateTime"/>.
- </summary>
- <param name="value">The value to be checked.</param>
- <exception cref="T:NAnt.Core.ValidationException"><paramref name="value"/> cannot be converted to a <see cref="T:System.DateTime"/>.</exception>
- </member>
- <member name="T:NAnt.Core.Attributes.ElementNameAttribute">
- <summary>
- Indicates that class should be treated as a NAnt element.
- </summary>
- <remarks>
- Attach this attribute to a subclass of Element to have NAnt be able
- to recognize it. The name should be short but must not confict
- with any other element already in use.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Attributes.ElementNameAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cre="ElementNameAttribute"/>
- with the specified name.
- </summary>
- <param name="name">The name of the element.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
- </member>
- <member name="P:NAnt.Core.Attributes.ElementNameAttribute.Name">
- <summary>
- Gets or sets the name of the element.
- </summary>
- <value>
- The name of the element.
- </value>
- </member>
- <member name="T:NAnt.Core.Attributes.FileSetAttribute">
- <summary>
- Indicates that a property should be treated as a XML file set for the
- task.
- </summary>
- </member>
- <member name="M:NAnt.Core.Attributes.FileSetAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.FileSetAttribute"/> with the
- specified name.
- </summary>
- <param name="name">The name of the attribute.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
- </member>
- <member name="T:NAnt.Core.Attributes.FrameworkConfigurableAttribute">
- <summary>
- Indicates that the value of the property to which the attribute is
- assigned, can be configured on the framework-level in the NAnt application
- configuration file.
- </summary>
- <example>
- <para>
- The following example shows a property of which the value can be
- configured for a specific framework in the NAnt configuration file.
- </para>
- <code lang="C#">
- [FrameworkConfigurable("exename", Required=true)]
- public virtual string ExeName {
- get { return _exeName; }
- set { _exeName = value; }
- }
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Attributes.FrameworkConfigurableAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.FrameworkConfigurableAttribute"/>
- with the specified attribute name.
- </summary>
- <param name="name">The name of the framework configuration attribute.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is a <see langword="null"/>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
- </member>
- <member name="P:NAnt.Core.Attributes.FrameworkConfigurableAttribute.Name">
- <summary>
- Gets or sets the name of the framework configuration attribute.
- </summary>
- <value>The name of the framework configuration attribute.</value>
- </member>
- <member name="P:NAnt.Core.Attributes.FrameworkConfigurableAttribute.Required">
- <summary>
- Gets or sets a value indicating whether the configuration attribute
- is required.
- </summary>
- <value>
- <see langword="true" /> if the configuration attribute is required;
- otherwise, <see langword="true" />. The default is <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.Attributes.FrameworkConfigurableAttribute.ExpandProperties">
- <summary>
- Gets or sets a value indicating whether property references should
- be expanded.
- </summary>
- <value>
- <see langword="true" /> if properties should be expanded; otherwise
- <see langword="false" />. The default is <see langword="true" />.
- </value>
- </member>
- <member name="T:NAnt.Core.Attributes.FunctionAttribute">
- <summary>
- Indicates that the method should be exposed as a function in NAnt build
- files.
- </summary>
- <remarks>
- Attach this attribute to a method of a class that derives from
- <see cref="T:NAnt.Core.FunctionSetBase"/> to have NAnt be able to recognize it.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Attributes.FunctionAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.FunctionAttribute"/>
- class with the specified name.
- </summary>
- <param name="name">The name of the function.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
- </member>
- <member name="P:NAnt.Core.Attributes.FunctionAttribute.Name">
- <summary>
- Gets or sets the name of the function.
- </summary>
- <value>
- The name of the function.
- </value>
- </member>
- <member name="T:NAnt.Core.Attributes.FunctionSetAttribute">
- <summary>
- Indicates that class should be treated as a set of functions.
- </summary>
- <remarks>
- Attach this attribute to a class that derives from <see cref="T:NAnt.Core.FunctionSetBase"/>
- to have NAnt be able to recognize it as containing custom functions.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Attributes.FunctionSetAttribute.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.FunctionSetAttribute"/>
- class with the specified name.
- </summary>
- <param name="prefix">The prefix used to distinguish the functions.</param>
- <param name="category">The category of the functions.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="prefix"/> is <see langword="null"/>.</para>
- <para>-or-</para>
- <para><paramref name="category"/> is <see langword="null"/>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="prefix"/> is a zero-length <see cref="T:System.String"/>.</para>
- <para>-or-</para>
- <para><paramref name="category"/> is a zero-length <see cref="T:System.String"/>.</para>
- </exception>
- </member>
- <member name="P:NAnt.Core.Attributes.FunctionSetAttribute.Category">
- <summary>
- Gets or sets the category of the function set.
- </summary>
- <value>
- The name of the category of the function set.
- </value>
- <remarks>
- This will be displayed in the user docs.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Attributes.FunctionSetAttribute.Prefix">
- <summary>
- Gets or sets the prefix of all functions in this function set.
- </summary>
- <value>
- The prefix of the functions in this function set.
- </value>
- </member>
- <member name="T:NAnt.Core.Attributes.Int32ValidatorAttribute">
- <summary>
- Indicates that property should be able to be converted into a <see cref="T:System.Int32"/>
- within the given range.
- </summary>
- </member>
- <member name="M:NAnt.Core.Attributes.Int32ValidatorAttribute.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.Int32ValidatorAttribute"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Attributes.Int32ValidatorAttribute.#ctor(System.Int32,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.Int32ValidatorAttribute"/>
- class with the specied minimum and maximum values.
- </summary>
- <param name="minValue">The minimum value.</param>
- <param name="maxValue">The maximum value.</param>
- </member>
- <member name="M:NAnt.Core.Attributes.Int32ValidatorAttribute.Validate(System.Object)">
- <summary>
- Checks whether the specified value can be converted to an <see cref="T:System.Int32"/>
- and whether the value lies within the range defined by the <see cref="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MinValue"/>
- and <see cref="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MaxValue"/> properties.
- </summary>
- <param name="value">The value to be checked.</param>
- <exception cref="T:NAnt.Core.ValidationException">
- <para>
- <paramref name="value"/> cannot be converted to an <see cref="T:System.Int32"/>.
- </para>
- <para>-or-</para>
- <para>
- <paramref name="value"/> is not in the range defined by <see cref="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MinValue"/>
- and <see cref="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MaxValue"/>.
- </para>
- </exception>
- </member>
- <member name="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MinValue">
- <summary>
- Gets or sets the minimum value.
- </summary>
- <value>
- The minimum value. The default is <see cref="F:System.Int32.MinValue"/>.
- </value>
- </member>
- <member name="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MaxValue">
- <summary>
- Gets or sets the maximum value.
- </summary>
- <value>
- The maximum value. The default is <see cref="F:System.Int32.MaxValue"/>.
- </value>
- </member>
- <member name="P:NAnt.Core.Attributes.Int32ValidatorAttribute.Base">
- <summary>
- The base of the number to validate, which must be 2, 8, 10, or 16.
- </summary>
- <value>
- The base of the number to validate.
- </value>
- <remarks>
- The default is 10.
- </remarks>
- </member>
- <member name="T:NAnt.Core.Attributes.LocationType">
- <summary>
- Defines possible locations in which a task executable can be located.
- </summary>
- </member>
- <member name="F:NAnt.Core.Attributes.LocationType.FrameworkDir">
- <summary>
- Locates the task executable in the current Framework directory.
- </summary>
- </member>
- <member name="F:NAnt.Core.Attributes.LocationType.FrameworkSdkDir">
- <summary>
- Locates the task executable in the current Framework SDK directory.
- </summary>
- </member>
- <member name="T:NAnt.Core.Attributes.ProgramLocationAttribute">
- <summary>
- Indicates the location that a task executable can be located in.
- </summary>
- </member>
- <member name="M:NAnt.Core.Attributes.ProgramLocationAttribute.#ctor(NAnt.Core.Attributes.LocationType)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.ProgramLocationAttribute"/>
- with the specified location.
- </summary>
- <param type="type">The <see cref="P:NAnt.Core.Attributes.ProgramLocationAttribute.LocationType"/> of the attribute.</param>
- </member>
- <member name="P:NAnt.Core.Attributes.ProgramLocationAttribute.LocationType">
- <summary>
- Gets or sets the <see cref="P:NAnt.Core.Attributes.ProgramLocationAttribute.LocationType"/> of the task.
- </summary>
- <value>
- The location type of the task to which the attribute is assigned.
- </value>
- </member>
- <member name="T:NAnt.Core.Attributes.StringValidatorAttribute">
- <summary>
- Used to indicate whether a <see cref="T:System.String"/> property should allow
- an empty string value or not.
- </summary>
- </member>
- <member name="M:NAnt.Core.Attributes.StringValidatorAttribute.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.StringValidatorAttribute"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Attributes.StringValidatorAttribute.Validate(System.Object)">
- <summary>
- Checks if the specified value adheres to the rules defined by the
- properties of the <see cref="T:NAnt.Core.Attributes.StringValidatorAttribute"/>.
- </summary>
- <param name="value">The value to be checked.</param>
- <exception cref="T:NAnt.Core.ValidationException"><paramref name="value"/> is an empty string value and <see cref="P:NAnt.Core.Attributes.StringValidatorAttribute.AllowEmpty"/> is set to <see langword="false"/>.</exception>
- </member>
- <member name="P:NAnt.Core.Attributes.StringValidatorAttribute.AllowEmpty">
- <summary>
- Gets or sets a value indicating whether an empty string or
- <see langword="null" /> should be a considered a valid value.
- </summary>
- <value>
- <see langword="true" /> if an empty string or <see langword="null" />
- should be considered a valid value; otherwise, <see langword="false" />.
- The default is <see langword="true" />.
- </value>
- </member>
- <member name="P:NAnt.Core.Attributes.StringValidatorAttribute.Expression">
- <summary>
- Gets or sets a regular expression. The string will be validated to
- determine if it matches the expression.
- </summary>
- <value>
- <see cref="N:System.Text.RegularExpressions"/>
- </value>
- </member>
- <member name="P:NAnt.Core.Attributes.StringValidatorAttribute.ExpressionErrorMessage">
- <summary>
- An optional error message that can be used to better describe the
- regular expression error.
- </summary>
- </member>
- <member name="T:NAnt.Core.Attributes.TaskAttributeAttribute">
- <summary>
- Indicates that property should be treated as a XML attribute for the
- task.
- </summary>
- <example>
- Examples of how to specify task attributes
- <code>
- // task XmlType default is string
- [TaskAttribute("out", Required=true)]
- string _out = null; // assign default value here
-
- [TaskAttribute("optimize")]
- [BooleanValidator()]
- // during ExecuteTask you can safely use Convert.ToBoolean(_optimize)
- string _optimize = Boolean.FalseString;
-
- [TaskAttribute("warnlevel")]
- [Int32Validator(0,4)] // limit values to 0-4
- // during ExecuteTask you can safely use Convert.ToInt32(_optimize)
- string _warnlevel = "0";
-
- [BuildElement("sources")]
- FileSet _sources = new FileSet();
- </code>
- NOTE: Attribute values must be of type of string if you want
- to be able to have macros. The field stores the exact value during
- InitializeTask. Just before ExecuteTask is called NAnt will expand
- all the macros with the current values.
- </example>
- </member>
- <member name="M:NAnt.Core.Attributes.TaskAttributeAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.TaskAttributeAttribute"/>
- with the specified attribute name.
- </summary>
- <param name="name">The name of the task attribute.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is a <see langword="null"/>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
- </member>
- <member name="T:NAnt.Core.Attributes.TaskNameAttribute">
- <summary>
- Indicates that class should be treated as a task.
- </summary>
- <remarks>
- Attach this attribute to a subclass of Task to have NAnt be able
- to recognize it. The name should be short but must not confict
- with any other task already in use.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Attributes.TaskNameAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.TaskNameAttribute"/>
- with the specified name.
- </summary>
- <param name="name">The name of the task.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
- </member>
- <member name="T:NAnt.Core.Filters.ChainableReader">
- <summary>
- Functions as a chainable TextReader
- </summary>
- <remarks>
- Implements a abstraction over a TextReader that allows the class to represent
- either a TextReader or another ChainableReader to which it is chained.
-
- By passing a ChainableReader as a constructor paramater it is possiable to
- chain many ChainableReaders together. The last ChainableReader in the chain must
- be based on a TextReader.
- </remarks>
- </member>
- <member name="T:NAnt.Core.Element">
- <summary>
- Models a NAnt XML element in the build file.
- </summary>
- <remarks>
- <para>
- Automatically validates attributes in the element based on attributes
- applied to members in derived classes.
- </para>
- </remarks>
- </member>
- <member name="M:NAnt.Core.Element.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Element"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Element.#ctor(NAnt.Core.Element)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Element"/> class
- from the specified element.
- </summary>
- <param name="e">The element that should be used to create a new instance of the <see cref="T:NAnt.Core.Element"/> class.</param>
- </member>
- <member name="M:NAnt.Core.Element.Initialize(System.Xml.XmlNode)">
- <summary>
- Performs default initialization.
- </summary>
- <remarks>
- Derived classes that wish to add custom initialization should override
- the <see cref="M:NAnt.Core.Element.InitializeElement(System.Xml.XmlNode)"/> method.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Element.Log(NAnt.Core.Level,System.String)">
- <summary>
- Logs a message with the given priority.
- </summary>
- <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
- <param name="message">The message to be logged.</param>
- <remarks>
- The actual logging is delegated to the project.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Element.Log(NAnt.Core.Level,System.String,System.Object[])">
- <summary>
- Logs a message with the given priority.
- </summary>
- <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
- <param name="message">The message to log, containing zero or more format items.</param>
- <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
- <remarks>
- The actual logging is delegated to the project.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Element.InitializeElement(System.Xml.XmlNode)">
- <summary>
- Derived classes should override to this method to provide extra
- initialization and validation not covered by the base class.
- </summary>
- <param name="elementNode">The XML node of the element to use for initialization.</param>
- </member>
- <member name="M:NAnt.Core.Element.CopyTo(NAnt.Core.Element)">
- <summary>
- Copies all instance data of the <see cref="T:NAnt.Core.Element"/> to a given
- <see cref="T:NAnt.Core.Element"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Element.Initialize(System.Xml.XmlNode,NAnt.Core.PropertyDictionary,NAnt.Core.FrameworkInfo)">
- <summary>
- Performs initialization using the given set of properties.
- </summary>
- </member>
- <member name="M:NAnt.Core.Element.InitializeXml(System.Xml.XmlNode,NAnt.Core.PropertyDictionary,NAnt.Core.FrameworkInfo)">
- <summary>
- Initializes all build attributes and child elements.
- </summary>
- </member>
- <member name="M:NAnt.Core.Element.GetAttributeConfigurationNode(NAnt.Core.FrameworkInfo,System.String)">
- <summary>
- Locates the XML node for the specified attribute in the project
- configuration node.
- </summary>
- <param name="attributeName">The name of attribute for which the XML configuration node should be located.</param>
- <param name="framework">The framework to use to obtain framework specific information, or <see langword="null" /> if no framework specific information should be used.</param>
- <returns>
- The XML configuration node for the specified attribute, or
- <see langword="null" /> if no corresponding XML node could be
- located.
- </returns>
- <remarks>
- If there's a valid current framework, the configuration section for
- that framework will first be searched. If no corresponding
- configuration node can be located in that section, the framework-neutral
- section of the project configuration node will be searched.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Element.GetElementNameFromType(System.Type)">
- <summary>
- Returns the <see cref="P:NAnt.Core.Attributes.ElementNameAttribute.Name"/> of the
- <see cref="T:NAnt.Core.Attributes.ElementNameAttribute"/> assigned to the specified
- <see cref="T:System.Type"/>.
- </summary>
- <param name="type">The <see cref="T:System.Type"/> of which the assigned <see cref="P:NAnt.Core.Attributes.ElementNameAttribute.Name"/> should be retrieved.</param>
- <returns>
- The <see cref="P:NAnt.Core.Attributes.ElementNameAttribute.Name"/> assigned to the specified
- <see cref="T:System.Type"/> or a null reference is no <see cref="P:NAnt.Core.Attributes.ElementNameAttribute.Name"/>
- is assigned to the <paramref name="type"/>.
- </returns>
- </member>
- <member name="P:NAnt.Core.Element.Parent">
- <summary>
- Gets or sets the parent of the element.
- </summary>
- <value>
- The parent of the element.
- </value>
- <remarks>
- This will be the parent <see cref="T:NAnt.Core.Task"/>, <see cref="T:NAnt.Core.Target"/>, or
- <see cref="P:NAnt.Core.Element.Project"/> depending on where the element is defined.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Element.Name">
- <summary>
- Gets the name of the XML element used to initialize this element.
- </summary>
- <value>
- The name of the XML element used to initialize this element.
- </value>
- </member>
- <member name="P:NAnt.Core.Element.Project">
- <summary>
- Gets or sets the <see cref="P:NAnt.Core.Element.Project"/> to which this element belongs.
- </summary>
- <value>
- The <see cref="P:NAnt.Core.Element.Project"/> to which this element belongs.
- </value>
- </member>
- <member name="P:NAnt.Core.Element.Properties">
- <summary>
- Gets the properties local to this <see cref="T:NAnt.Core.Element"/> and the
- <see cref="P:NAnt.Core.Element.Project"/>.
- </summary>
- <value>
- The properties local to this <see cref="T:NAnt.Core.Element"/> and the <see cref="P:NAnt.Core.Element.Project"/>.
- </value>
- </member>
- <member name="P:NAnt.Core.Element.NamespaceManager">
- <summary>
- Gets or sets the <see cref="T:System.Xml.XmlNamespaceManager"/>.
- </summary>
- <value>
- The <see cref="T:System.Xml.XmlNamespaceManager"/>.
- </value>
- <remarks>
- The <see cref="P:NAnt.Core.Element.NamespaceManager"/> defines the current namespace
- scope and provides methods for looking up namespace information.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Element.XmlNode">
- <summary>
- Gets or sets the XML node of the element.
- </summary>
- <value>
- The XML node of the element.
- </value>
- </member>
- <member name="P:NAnt.Core.Element.Location">
- <summary>
- Gets or sets the location in the build file where the element is
- defined.
- </summary>
- <value>
- The location in the build file where the element is defined.
- </value>
- </member>
- <member name="P:NAnt.Core.Element.CustomXmlProcessing">
- <summary>
- Gets a value indicating whether the element is performing additional
- processing using the <see cref="P:NAnt.Core.Element.XmlNode"/> that was used to
- initialize the element.
- </summary>
- <value>
- <see langword="false"/>.
- </value>
- <remarks>
- <para>
- Elements that need to perform additional processing of the
- <see cref="P:NAnt.Core.Element.XmlNode"/> that was used to initialize the element, should
- override this property and return <see langword="true"/>.
- </para>
- <para>
- When <see langword="true"/>, no build errors will be reported for
- unknown nested build elements.
- </para>
- </remarks>
- </member>
- <member name="T:NAnt.Core.Element.AttributeConfigurator">
- <summary>
- Configures an <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> using meta-data provided by
- assigned attributes.
- </summary>
- </member>
- <member name="M:NAnt.Core.Element.AttributeConfigurator.#ctor(NAnt.Core.Element,System.Xml.XmlNode,NAnt.Core.PropertyDictionary,NAnt.Core.FrameworkInfo)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Element.AttributeConfigurator"/>
- class for the given <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/>.
- </summary>
- <param name="element">The <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> for which an <see cref="T:NAnt.Core.Element.AttributeConfigurator"/> should be created.</param>
- <param name="elementNode">The <see cref="P:NAnt.Core.Element.XmlNode"/> to initialize the <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> with.</param>
- <param name="properties">The <see cref="T:NAnt.Core.PropertyDictionary"/> to use for property expansion.</param>
- <param name="targetFramework">The framework that the <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> should target.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="element"/> is <see langword="null"/>.</para>
- <para>-or-</para>
- <para><paramref name="elementNode"/> is <see langword="null"/>.</para>
- <para>-or-</para>
- <para><paramref name="properties"/> is <see langword="null"/>.</para>
- </exception>
- </member>
- <member name="M:NAnt.Core.Element.AttributeConfigurator.CreateChildBuildElement(System.Reflection.PropertyInfo,System.Xml.XmlNode,NAnt.Core.PropertyDictionary,NAnt.Core.FrameworkInfo)">
- <summary>
- Creates a child <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> using property set/get methods.
- </summary>
- <param name="propInf">The <see cref="T:System.Reflection.PropertyInfo"/> instance that represents the property of the current class.</param>
- <param name="xml">The <see cref="P:NAnt.Core.Element.XmlNode"/> used to initialize the new <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> instance.</param>
- <param name="properties">The collection of property values to use for macro expansion.</param>
- <param name="framework">The <see cref="T:NAnt.Core.FrameworkInfo"/> from which to obtain framework-specific information.</param>
- <returns>The <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> child.</returns>
- </member>
- <member name="M:NAnt.Core.Element.AttributeConfigurator.CreateAttributeSetter(System.Type)">
- <summary>
- Creates an <see cref="T:NAnt.Core.Element.AttributeConfigurator.IAttributeSetter"/> for the given
- <see cref="T:System.Type"/>.
- </summary>
- <param name="attributeType">The <see cref="T:System.Type"/> for which an <see cref="T:NAnt.Core.Element.AttributeConfigurator.IAttributeSetter"/> should be created.</param>
- <returns>
- An <see cref="T:NAnt.Core.Element.AttributeConfigurator.IAttributeSetter"/> for the given <see cref="T:System.Type"/>.
- </returns>
- </member>
- <member name="F:NAnt.Core.Element.AttributeConfigurator._element">
- <summary>
- Holds the <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> that should be initialized.
- </summary>
- </member>
- <member name="F:NAnt.Core.Element.AttributeConfigurator._elementXml">
- <summary>
- Holds the <see cref="P:NAnt.Core.Element.XmlNode"/> that should be used to initialize
- the <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/>.
- </summary>
- </member>
- <member name="F:NAnt.Core.Element.AttributeConfigurator._properties">
- <summary>
- Holds the dictionary that should be used for property
- expansion.
- </summary>
- </member>
- <member name="F:NAnt.Core.Element.AttributeConfigurator._targetFramework">
- <summary>
- Holds the framework that should be targeted by the
- <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> that we're configuring, or
- <see langword="null"/> if there's no current target
- framework.
- </summary>
- </member>
- <member name="F:NAnt.Core.Element.AttributeConfigurator._unprocessedAttributes">
- <summary>
- Holds the names of the attributes that still need to be
- processed.
- </summary>
- </member>
- <member name="F:NAnt.Core.Element.AttributeConfigurator._unprocessedChildNodes">
- <summary>
- Holds the names of the child nodes that still need to be
- processed.
- </summary>
- </member>
- <member name="F:NAnt.Core.Element.AttributeConfigurator.logger">
- <summary>
- Holds the logger for the current class.
- </summary>
- </member>
- <member name="F:NAnt.Core.Element.AttributeConfigurator.AttributeSetters">
- <summary>
- Holds the cache of <see cref="T:NAnt.Core.Element.AttributeConfigurator.IAttributeSetter"/> instances.
- </summary>
- </member>
- <member name="P:NAnt.Core.Element.AttributeConfigurator.NamespaceManager">
- <summary>
- Gets the <see cref="T:System.Xml.XmlNamespaceManager"/>.
- </summary>
- <value>
- The <see cref="T:System.Xml.XmlNamespaceManager"/>.
- </value>
- <remarks>
- The <see cref="P:NAnt.Core.Element.AttributeConfigurator.NamespaceManager"/> defines the current namespace
- scope and provides methods for looking up namespace information.
- </remarks>
- </member>
- <member name="T:NAnt.Core.Element.AttributeConfigurator.IAttributeSetter">
- <summary>
- Internal interface used for setting element attributes.
- </summary>
- </member>
- <member name="M:NAnt.Core.Filters.ChainableReader.Chain(NAnt.Core.Filters.ChainableReader)">
- <summary>
- Makes it so all calls to Read and Peek are passed the ChainableReader
- passed as a parameter.
- </summary>
- <param name="parentChainedReader">ChainableReader to forward calls to</param>
- </member>
- <member name="M:NAnt.Core.Filters.ChainableReader.Chain(System.IO.TextReader)">
- <summary>
- Makes it so all calls to Read and Peek are passed the TextReader
- passed as a parameter.
- </summary>
- <param name="baseReader">TextReader to forward calls to</param>
- </member>
- <member name="M:NAnt.Core.Filters.ChainableReader.Peek">
- <summary>
- Forwards Peek calls to the TextReader or ChainableReader passed in the corresponding constructor.
- </summary>
- <returns>Character or -1 if end of stream</returns>
- </member>
- <member name="M:NAnt.Core.Filters.ChainableReader.Read">
- <summary>
- Forwards Read calls to the TextReader or ChainableReader passed in the corresponding constructor.
- </summary>
- <returns>
- Character or -1 if end of stream.
- </returns>
- </member>
- <member name="M:NAnt.Core.Filters.ChainableReader.Close">
- <summary>
- Closes the reader.
- </summary>
- </member>
- <member name="M:NAnt.Core.Filters.ChainableReader.Dispose">
- <summary>
- Calls close and supresses the finalizer for the object.
- </summary>
- </member>
- <member name="P:NAnt.Core.Filters.ChainableReader.Base">
- <summary>
- Gets a value indicating if the reader is backed by a stream in the
- chain.
- </summary>
- <value>
- <see langword="true" /> if the reader is backed by a stream;
- otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="T:NAnt.Core.Filters.Filter">
- <summary>
- Allows a file's content to be modified while performing an operation.
- </summary>
- </member>
- <member name="M:NAnt.Core.Filters.Filter.InitializeFilter">
- <summary>
- Called after construction and after properties are set. Allows
- for filter initialization.
- </summary>
- </member>
- <member name="P:NAnt.Core.Filters.Filter.IfDefined">
- <summary>
- If <see langword="true" /> then the filter will be used; otherwise,
- skipped. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Filters.Filter.UnlessDefined">
- <summary>
- Opposite of <see cref="P:NAnt.Core.Filters.Filter.IfDefined"/>. If <see langword="false"/>
- then the filter will be executed; otherwise, skipped. The default
- is <see langword="false"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Filters.FilterBuilder.#ctor(System.Reflection.Assembly,System.String)">
- <summary>
- Creates a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> class
- for the specified <see cref="T:NAnt.Core.Filters.Filter"/> class in the <see cref="P:NAnt.Core.Filters.FilterBuilder.Assembly"/>
- specified.
- </summary>
- <param name="assembly">The <see cref="P:NAnt.Core.Filters.FilterBuilder.Assembly"/> containing the <see cref="T:NAnt.Core.Filters.Filter"/>.</param>
- <param name="className">The class representing the <see cref="T:NAnt.Core.Filters.Filter"/>.</param>
- </member>
- <member name="P:NAnt.Core.Filters.FilterBuilder.ClassName">
- <summary>
- Gets the name of the <see cref="T:NAnt.Core.Filters.Filter"/> class that can be created
- using this <see cref="T:NAnt.Core.Filters.FilterBuilder"/>.
- </summary>
- <value>
- The name of the <see cref="T:NAnt.Core.Filters.Filter"/> class that can be created using
- this <see cref="T:NAnt.Core.Filters.FilterBuilder"/>.
- </value>
- </member>
- <member name="P:NAnt.Core.Filters.FilterBuilder.Assembly">
- <summary>
- Gets the <see cref="P:NAnt.Core.Filters.FilterBuilder.Assembly"/> from which the filter will be
- created.
- </summary>
- <value>
- The <see cref="P:NAnt.Core.Filters.FilterBuilder.Assembly"/> containing the filter.
- </value>
- </member>
- <member name="P:NAnt.Core.Filters.FilterBuilder.FilterName">
- <summary>
- Gets the name of the filter which the <see cref="T:NAnt.Core.Filters.FilterBuilder"/>
- can create.
- </summary>
- <value>
- The name of the task which the <see cref="T:NAnt.Core.TaskBuilder"/> can
- create.
- </value>
- </member>
- <member name="T:NAnt.Core.Filters.FilterBuilderCollection">
- <summary>
- Contains a strongly typed collection of <see cref="T:NAnt.Core.Filters.FilterBuilder"/> objects.
- </summary>
- </member>
- <member name="M:NAnt.Core.Filters.FilterBuilderCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Filters.FilterBuilderCollection.#ctor(NAnt.Core.Filters.FilterBuilderCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> class
- with the specified <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.Core.Filters.FilterBuilderCollection.#ctor(NAnt.Core.Filters.FilterBuilder[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> class
- with the specified array of <see cref="T:NAnt.Core.Filters.FilterBuilder"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.Core.Filters.FilterBuilderCollection.Add(NAnt.Core.Filters.FilterBuilder)">
- <summary>
- Adds a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Filters.FilterBuilder"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.Core.Filters.FilterBuilderCollection.AddRange(NAnt.Core.Filters.FilterBuilder[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.Core.Filters.FilterBuilder"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Filters.FilterBuilderCollection.AddRange(NAnt.Core.Filters.FilterBuilderCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Filters.FilterBuilderCollection.Contains(NAnt.Core.Filters.FilterBuilder)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Filters.FilterBuilder"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Filters.FilterBuilderCollection.Contains(System.String)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> for the specified
- task is in the collection.
- </summary>
- <param name="taskName">The name of task for which the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> should be located in the collection.</param>
- <returns>
- <see langword="true"/> if a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> for
- the specified task is found in the collection; otherwise,
- <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Filters.FilterBuilderCollection.CopyTo(NAnt.Core.Filters.FilterBuilder[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.Core.Filters.FilterBuilderCollection.IndexOf(NAnt.Core.Filters.FilterBuilder)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.Core.Filters.FilterBuilder"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Filters.FilterBuilder"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.Core.Filters.FilterBuilder"/>. If the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.Core.Filters.FilterBuilderCollection.Insert(System.Int32,NAnt.Core.Filters.FilterBuilder)">
- <summary>
- Inserts a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.Core.Filters.FilterBuilder"/> to insert.</param>
- </member>
- <member name="M:NAnt.Core.Filters.FilterBuilderCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.Core.Filters.FilterBuilderEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Filters.FilterBuilderCollection.Remove(NAnt.Core.Filters.FilterBuilder)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Filters.FilterBuilder"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.Core.Filters.FilterBuilderCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="P:NAnt.Core.Filters.FilterBuilderCollection.Item(System.String)">
- <summary>
- Gets the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> for the specified task.
- </summary>
- <param name="filterName">The name of the filter for which the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> should be located in the collection.</param>
- </member>
- <member name="T:NAnt.Core.Filters.FilterBuilderEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> elements of a <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Filters.FilterBuilderEnumerator.#ctor(NAnt.Core.Filters.FilterBuilderCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilderEnumerator"/> class
- with the specified <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.Core.Filters.FilterBuilderEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Filters.FilterBuilderEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.Core.Filters.FilterBuilderEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.Core.Filters.FilterChain">
- <summary>
- Represent a chain of NAnt filters that can be applied to a <see cref="T:NAnt.Core.Task"/>.
- </summary>
- <remarks>
- <para>
- A FilterChain represents a collection of one or more filters that can
- be appled to a <see cref="T:NAnt.Core.Task"/> such as the <see cref="T:NAnt.Core.Tasks.CopyTask"/>.
- In the case of the <see cref="T:NAnt.Core.Tasks.CopyTask"/>, the contents of the copied
- files are filtered through each filter specified in the filter chain.
- Filtering occurs in the order the filters are specified with filtered
- output of one filter feeding into another.
- </para>
- <para>
- :--------:--->:----------:--->:----------: ... :----------:--->:--------:<br/>
- :.Source.:--->:.Filter 1.:--->:.Filter 2.: ... :.Filter n.:--->:.target.:<br/>
- :--------:--->:----------:--->:----------: ... :----------:--->:--------:<br/>
- </para>
- <para>
- A list of all filters that come with NAnt is available <see href="../filters/index.html">here</see>.
- </para>
- <para>
- The following tasks support filtering with a FilterChain:
- </para>
- <list type="bullet">
- <item>
- <description><see cref="T:NAnt.Core.Tasks.CopyTask"/></description>
- </item>
- <item>
- <description><see cref="T:NAnt.Core.Tasks.MoveTask"/></description>
- </item>
- </list>
- </remarks>
- <example>
- <para>
- Replace all occurrences of @NOW@ with the current date/time and
- replace tabs with spaces in all copied files.
- </para>
- <code>
- <![CDATA[
- <property name="NOW" value="${datetime::now()}" />
- <copy todir="out">
- <fileset basedir="in">
- <include name="**/*" />
- </fileset>
- <filterchain>
- <replacetokens>
- <token key="NOW" value="${TODAY}" />
- </replacetokens>
- <tabstospaces />
- </filterchain>
- </copy>
- ]]>
- </code>
- </example>
- </member>
- <member name="T:NAnt.Core.DataTypeBase">
- <summary>
- Provides the abstract base class for types.
- </summary>
- </member>
- <member name="M:NAnt.Core.DataTypeBase.Reset">
- <summary>
- Should be overridden by derived classes. clones the referenced types
- data into the current instance.
- </summary>
- </member>
- <member name="M:NAnt.Core.DataTypeBase.CopyTo(NAnt.Core.DataTypeBase)">
- <summary>
- Copies all instance data of the <see cref="T:NAnt.Core.DataTypeBase"/> to a given
- <see cref="T:NAnt.Core.DataTypeBase"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.DataTypeBase.ID">
- <summary>
The ID used to be referenced later.
</summary>
- </member>
- <member name="P:NAnt.Core.DataTypeBase.RefID">
- <summary>
The ID to use as the reference.
</summary>
- </member>
- <member name="P:NAnt.Core.DataTypeBase.CanBeReferenced">
- <summary>
- Gets a value indicating whether a reference to the type can be
- defined.
- </summary>
- <remarks>
- Only types with an <see cref="T:NAnt.Core.Attributes.ElementNameAttribute"/> assigned
- to it, can be referenced.
- </remarks>
- </member>
- <member name="P:NAnt.Core.DataTypeBase.Name">
- <summary>
- Gets the name of the datatype.
- </summary>
- <value>
- The name of the datatype.
- </value>
- </member>
- <member name="M:NAnt.Core.Filters.FilterChain.InitializeXml(System.Xml.XmlNode,NAnt.Core.PropertyDictionary,NAnt.Core.FrameworkInfo)">
- <summary>
- Initializes all build attributes and child elements.
- </summary>
- <remarks>
- <see cref="T:NAnt.Core.Filters.FilterChain"/> needs to maintain the order in which the
- filters are specified in the build file.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Filters.FilterChain.GetBaseFilter(NAnt.Core.Filters.PhysicalTextReader)">
- <summary>
- Used to to instantiate and return the chain of stream based filters.
- </summary>
- <param name="physicalTextReader">The <see cref="T:NAnt.Core.Filters.PhysicalTextReader"/> that is the source of input to the filter chain.</param>
- <remarks>
- The <paramref name="physicalTextReader"/> is the first <see cref="T:NAnt.Core.Filters.Filter"/>
- in the chain, which is based on a physical stream that feeds the chain.
- </remarks>
- <returns>
- The last <see cref="T:NAnt.Core.Filters.Filter"/> in the chain.
- </returns>
- </member>
- <member name="P:NAnt.Core.Filters.FilterChain.Filters">
- <summary>
- The filters to apply.
- </summary>
- </member>
- <member name="P:NAnt.Core.Filters.FilterChain.InputEncoding">
- <summary>
- The encoding to assume when filter-copying files. The default is
- system's current ANSI code page.
- </summary>
- </member>
- <member name="T:NAnt.Core.Filters.FilterChain.FilterChainConfigurator">
- <summary>
- Configurator that initializes filters in the order in which they've
- been specified in the build file.
- </summary>
- </member>
- <member name="T:NAnt.Core.Filters.FilterCollection">
- <summary>
- Contains a collection of <see cref="T:NAnt.Core.Filters.Filter"/> elements.
- </summary>
- </member>
- <member name="M:NAnt.Core.Filters.FilterCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Filters.FilterCollection.#ctor(NAnt.Core.Filters.FilterCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterCollection"/> class
- with the specified <see cref="T:NAnt.Core.Filters.FilterCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.Core.Filters.FilterCollection.#ctor(NAnt.Core.Filters.Filter[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterCollection"/> class
- with the specified array of <see cref="T:NAnt.Core.Filters.Filter"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.Core.Filters.FilterCollection.Add(NAnt.Core.Filters.Filter)">
- <summary>
- Adds a <see cref="T:NAnt.Core.Filters.Filter"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Filters.Filter"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.Core.Filters.FilterCollection.AddRange(NAnt.Core.Filters.Filter[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Filters.Filter"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.Core.Filters.Filter"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Filters.FilterCollection.AddRange(NAnt.Core.Filters.FilterCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Filters.FilterCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.Core.Filters.FilterCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Filters.FilterCollection.Contains(NAnt.Core.Filters.Filter)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.Filters.Filter"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Filters.Filter"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Filters.FilterCollection.CopyTo(NAnt.Core.Filters.Filter[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.Core.Filters.FilterCollection.IndexOf(NAnt.Core.Filters.Filter)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.Core.Filters.Filter"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Filters.Filter"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.Core.Filters.Filter"/>. If the <see cref="T:NAnt.Core.Filters.Filter"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.Core.Filters.FilterCollection.Insert(System.Int32,NAnt.Core.Filters.Filter)">
- <summary>
- Inserts a <see cref="T:NAnt.Core.Filters.Filter"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.Core.Filters.Filter"/> to insert.</param>
- </member>
- <member name="M:NAnt.Core.Filters.FilterCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.Core.Filters.FilterEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Filters.FilterCollection.Remove(NAnt.Core.Filters.Filter)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Filters.Filter"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.Core.Filters.FilterCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="T:NAnt.Core.Filters.FilterEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.Core.Filters.Filter"/> elements of a <see cref="T:NAnt.Core.Filters.FilterCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Filters.FilterEnumerator.#ctor(NAnt.Core.Filters.FilterCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterEnumerator"/> class
- with the specified <see cref="T:NAnt.Core.Filters.FilterCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.Core.Filters.FilterEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Filters.FilterEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.Core.Filters.FilterEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.Core.Filters.PhysicalTextReader">
- <summary>
- Represents a physical <see cref="T:System.IO.TextReader"/>. That is a reader based
- on a stream.
- </summary>
- <remarks>
- Used by <see cref="T:NAnt.Core.Filters.ChainableReader"/> to represent a <see cref="T:NAnt.Core.Filters.Filter"/>
- based on a <see cref="T:System.IO.TextReader"/> in the chain.
- </remarks>
- </member>
- <member name="T:NAnt.Core.Filters.ExpandProperties">
- <summary>
- Parses NAnt properties and expressions
- </summary>
- <remarks>
- <para>
- This filter parses any NAnt properties or expressions found in its input,
- inlining their values in its output.
- </para>
- <para>
- Note: Due to limitations on buffering, expressions longer than 2048
- characters are not guaranteed to be expanded.
- </para>
- Filters are intended to be used as a element of a <see cref="T:NAnt.Core.Filters.FilterChain"/>.
- </remarks>
- <example>
- <para>Replace all properties with their corresponding values.</para>
- <code>
- <![CDATA[
- <expandproperties />
- ]]>
- </code>
- </example>
- </member>
- <member name="F:NAnt.Core.Filters.ExpandProperties._buffer">
- <summary>
- Holds data for expression expansion between input and output.
- </summary>
- </member>
- <member name="M:NAnt.Core.Filters.ExpandProperties.InitializeFilter">
- <summary>
- Called after construction and after properties are set. Allows
- for filter initialization.
- </summary>
- </member>
- <member name="M:NAnt.Core.Filters.ExpandProperties.Read">
- <summary>
- Reads the next character applying the filter logic.
- </summary>
- <returns>Char as an int or -1 if at the end of the stream</returns>
- </member>
- <member name="M:NAnt.Core.Filters.ExpandProperties.Peek">
- <summary>
- Reads the next character applying the filter logic without advancing the current position in the stream.
- </summary>
- <returns>Char as an int or -1 if at the end of the stream</returns>
- </member>
- <member name="M:NAnt.Core.Filters.ExpandProperties.Advance">
- <summary>
- Moves to the next character.
- </summary>
- </member>
- <member name="M:NAnt.Core.Filters.ExpandProperties.ReplenishBuffer">
- <summary>
- Refills the buffer, running our input through
- <see cref="M:NAnt.Core.PropertyDictionary.ExpandProperties(System.String,NAnt.Core.Location)"/>.)
- </summary>
- </member>
- <member name="P:NAnt.Core.Filters.ExpandProperties.AtEnd">
- <summary>
- Determines whether we've passed the end of our data.
- </summary>
- </member>
- <member name="T:NAnt.Core.Filters.ReplaceString">
- <summary>
- Replaces all occurrences of a given string in the original input with
- user-supplied replacement string.
- </summary>
- <remarks>
- <para>
- This filter replaces all occurrences of a given string in the original
- input stream with a user-supplied replacement string. By default string
- comparisons are case sensitive but this can be changed by setting the
- optional <see cref="P:NAnt.Core.Filters.ReplaceString.IgnoreCase"/> attribute to <see langword="true"/>.
- </para>
- <para>
- To use this filter specify the string to be replaced with the
- <see cref="P:NAnt.Core.Filters.ReplaceString.From"/> attribute and the string to replace it with using the
- <see cref="P:NAnt.Core.Filters.ReplaceString.To"/> attribute.
- </para>
- <para>
- Filters are intended to be used as a element of a <see cref="T:NAnt.Core.Filters.FilterChain"/>.
- </para>
- </remarks>
- <example>
- <para>
- Replace all occurrences of "3.14" with "PI".
- </para>
- <code>
- <![CDATA[
- <replacestring from="3.14" to="PI" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Replace all occurrences of "string", "String", etc. with "System.String".
- </para>
- <code>
- <![CDATA[
- <replacestring from="String" to="System.String" ignorecase="true" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Filters.ReplaceString.Chain(NAnt.Core.Filters.ChainableReader)">
- <summary>
- Construct that allows this filter to be chained to the one
- in the parameter chainedReader.
- </summary>
- <param name="chainedReader">Filter that the filter will be chained to</param>
- </member>
- <member name="M:NAnt.Core.Filters.ReplaceString.Read">
- <summary>
- Reads the next character applying the filter logic.
- </summary>
- <returns>Char as an int or -1 if at the end of the stream</returns>
- </member>
- <member name="M:NAnt.Core.Filters.ReplaceString.Peek">
- <summary>
- Reads the next character applying the filter logic without
- advancing the current position in the stream.
-
- Peek currently is not supported.
- </summary>
- <returns>
- Char as an int or -1 if at the end of the stream.
- </returns>
- </member>
- <member name="M:NAnt.Core.Filters.ReplaceString.FindString(System.Int32,System.Boolean@,System.String@)">
- <summary>
- <para>
- Helper function used to search for the filter's traget string. If the string
- is found the result is true. If the string was not found false is returned and
- nonMatchingChars contains the characters that were read to determine if the
- string is present.
- </para>
-
- <para>
- It is assumed the stream is positioned at the character after the first character
- in the target string.
- </para>
- </summary>
- <param name="startChar">First character in target string</param>
- <param name="streamEnded">Ture if the stream ended while search for the string.</param>
- <param name="nonMatchingChars">Characters that were read while searching for the string.</param>
- <returns></returns>
- </member>
- <member name="M:NAnt.Core.Filters.ReplaceString.GetNextCharacter(NAnt.Core.Filters.ReplaceString.AcquireCharDelegate)">
- <summary>
- Returns the next character in the stream replacing the specified character. Using the
- <see cref="T:NAnt.Core.Filters.ReplaceString.AcquireCharDelegate"/> allows for the same implementation for Read and Peek
- </summary>
- <param name="AcquireChar">Delegate to acquire the next character. (Read/Peek)</param>
- <returns>Char as an int or -1 if at the end of the stream</returns>
- </member>
- <member name="M:NAnt.Core.Filters.ReplaceString.CompareCharacters(System.Int32,System.Int32)">
- <summary>
- Compares to characters taking into account the _ignoreCase flag.
- </summary>
- <param name="char1"></param>
- <param name="char2"></param>
- <returns></returns>
- </member>
- <member name="P:NAnt.Core.Filters.ReplaceString.From">
- <summary>
- The string to be replaced.
- </summary>
- </member>
- <member name="P:NAnt.Core.Filters.ReplaceString.To">
- <summary>
- The new value for the replaced string.
- Am empty string is permissible.
- </summary>
- </member>
- <member name="P:NAnt.Core.Filters.ReplaceString.IgnoreCase">
- <summary>
- Determines if case will be ignored.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="T:NAnt.Core.Filters.ReplaceString.AcquireCharDelegate">
- <summary>
- Delegate for Read and Peek. Allows the same implementation
- to be used for both methods.
- </summary>
- </member>
- <member name="T:NAnt.Core.Filters.ReplaceTokens">
- <summary>
- Replaces tokens in the original input with user-supplied values.
- </summary>
- <remarks>
- <para>
- This filter replaces all token surrounded by a beginning and ending
- token. The default beginning and ending tokens both default to '@'. The
- optional <see cref="P:NAnt.Core.Filters.ReplaceTokens.BeginToken"/> and <see cref="P:NAnt.Core.Filters.ReplaceTokens.EndToken"/> attributes
- can be specified to change either token. By default string
- comparisons are case sensitive but this can be changed by setting the
- optional <see cref="P:NAnt.Core.Filters.ReplaceTokens.IgnoreCase"/> attribute to <see langword="true"/>.
- </para>
- <para>
- Tokens are specified by using the <see cref="T:NAnt.Core.Types.Token"/> element. It is
- possible to specify from 1 to n tokens and replacement values. Values can
- be any valid NAnt expression.
- </para>
- <para>
- Filters are intended to be used as a element of a <see cref="T:NAnt.Core.Filters.FilterChain"/>.
- </para>
- </remarks>
- <example>
- <para>
- Replace all occurrences of the string @DATE@ with the value of property
- "TODAY".
- </para>
- <code>
- <![CDATA[
- <replacetokens>
- <token key="DATE" value="${TODAY}" />
- </replacetokens>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Replace all occurrences of the string <DATE> with the value of
- property "TODAY".
- </para>
- <code>
- <![CDATA[
- <replacetokens begintoken="<" endtoken=">">
- <token key="DATE" value="${TODAY}" />
- </replacetokens>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Filters.ReplaceTokens.Chain(NAnt.Core.Filters.ChainableReader)">
- <summary>
- Construct that allows this filter to be chained to the one
- in the parameter chainedReader.
- </summary>
- <param name="chainedReader">Filter that the filter will be chained to</param>
- </member>
- <member name="M:NAnt.Core.Filters.ReplaceTokens.Read">
- <summary>
- Reads the next character applying the filter logic.
- </summary>
- <returns>Char as an int or -1 if at the end of the stream</returns>
- </member>
- <member name="M:NAnt.Core.Filters.ReplaceTokens.Peek">
- <summary>
- Reads the next character applying the filter logic without
- advancing the current position in the stream.
-
- Peek currently is not supported.
- </summary>
- <returns>
- Char as an int or -1 if at the end of the stream.
- </returns>
- </member>
- <member name="M:NAnt.Core.Filters.ReplaceTokens.InitializeElement(System.Xml.XmlNode)">
- <summary>
- Initialize the filter by setting its parameters.
- </summary>
- </member>
- <member name="M:NAnt.Core.Filters.ReplaceTokens.FindTokenContents(System.Boolean@,System.Boolean@,System.Boolean@)">
- <summary>
- Finds a token give that we are positioned at a beginning token character. Either a
- token replacement is returned or the characters that were read looking for the token.
- </summary>
- <param name="tokenNotFound">A token was not found</param>
- <param name="unknownToken">A token was found by there is no replacement</param>
- <param name="streamEnded">The stream ended while looking for the token</param>
- <returns>Either the replacement token or the characters that were read looking for the token</returns>
- </member>
- <member name="M:NAnt.Core.Filters.ReplaceTokens.GetNextCharacter(NAnt.Core.Filters.ReplaceTokens.AcquireCharDelegate)">
- <summary>
- Returns the next character in the stream replacing the specified character. Using the
- <see cref="T:NAnt.Core.Filters.ReplaceTokens.AcquireCharDelegate"/> allows for the same implementation for Read and Peek
- </summary>
- <param name="AcquireChar">Delegate to acquire the next character. (Read/Peek)</param>
- <returns>Char as an int or -1 if at the end of the stream</returns>
- </member>
- <member name="M:NAnt.Core.Filters.ReplaceTokens.CompareCharacters(System.Int32,System.Int32)">
- <summary>
- Compares to characters taking <see cref="P:NAnt.Core.Filters.ReplaceTokens.IgnoreCase"/> into account.
- </summary>
- <param name="char1"></param>
- <param name="char2"></param>
- <returns>
- </returns>
- </member>
- <member name="P:NAnt.Core.Filters.ReplaceTokens.BeginToken">
- <summary>
- Marks the beginning of a token. The default is "@".
- </summary>
- </member>
- <member name="P:NAnt.Core.Filters.ReplaceTokens.EndToken">
- <summary>
- Marks the end of a token. The default is "@".
- </summary>
- </member>
- <member name="P:NAnt.Core.Filters.ReplaceTokens.Tokens">
- <summary>
- Tokens and replacement values.
- </summary>
- </member>
- <member name="P:NAnt.Core.Filters.ReplaceTokens.IgnoreCase">
- <summary>
- Determines if case will be ignored.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="T:NAnt.Core.Filters.ReplaceTokens.AcquireCharDelegate">
- <summary>
- Delegate for Read and Peek. Allows the same implementation
- to be used for both methods.
- </summary>
- </member>
- <member name="T:NAnt.Core.Filters.TabsToSpaces">
- <summary>
- Converts tabs to spaces.
- </summary>
- <remarks>
- <para>
- The <see cref="T:NAnt.Core.Filters.TabsToSpaces"/> filter replaces tabs in a text file
- with spaces.
- </para>
- <para>
- Filters are intended to be used as a element of a <see cref="T:NAnt.Core.Filters.FilterChain"/>.
- </para>
- </remarks>
- <example>
- <para>Replace all tabs with four spaces.</para>
- <code>
- <![CDATA[
- <tabtospaces tablength="4" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Filters.TabsToSpaces.Chain(NAnt.Core.Filters.ChainableReader)">
- <summary>
- Construct that allows this filter to be chained to the one
- in the parameter chainedReader.
- </summary>
- <param name="chainedReader">Filter that the filter will be chained to</param>
- </member>
- <member name="M:NAnt.Core.Filters.TabsToSpaces.Peek">
- <summary>
- <para>Retrieves the next character with moving the position in the stream.</para>
- <note>This method is not implemented</note>
- </summary>
- <returns>-1 if end of stream otherwise a character</returns>
- </member>
- <member name="M:NAnt.Core.Filters.TabsToSpaces.Read">
- <summary>
- <para>Retrieves the next character in the stream.</para>
- </summary>
- <returns>-1 if end of stream otherwise a character</returns>
- </member>
- <member name="M:NAnt.Core.Filters.TabsToSpaces.GetNextCharacter(NAnt.Core.Filters.TabsToSpaces.AcquireCharDelegate)">
- <summary>
- Returns the next character in the stream replacing the specified character. Using the
- <see cref="T:NAnt.Core.Filters.TabsToSpaces.AcquireCharDelegate"/> allows for the same implementation for Read and Peek
- </summary>
- <param name="AcquireChar">Delegate to acquire the next character. (Read/Peek)</param>
- <returns>Char as an int or -1 if at the end of the stream</returns>
- </member>
- <member name="P:NAnt.Core.Filters.TabsToSpaces.TabLength">
- <summary>
- The number of spaces used when converting a tab. The default is
- "8".
- </summary>
- </member>
- <member name="T:NAnt.Core.Filters.TabsToSpaces.AcquireCharDelegate">
- <summary>
- Delegate for Read and Peek. Allows the same implementation
- to be used for both methods.
- </summary>
- </member>
- <member name="T:NAnt.Core.Functions.AssemblyFunctions">
- <summary>
- Functions to return information for a given assembly.
- </summary>
- </member>
- <member name="P:NAnt.Core.FunctionSetBase.Project">
- <summary>
- Gets or sets the <see cref="P:NAnt.Core.FunctionSetBase.Project"/> that this functionset will
- reference.
- </summary>
- <value>
- The <see cref="P:NAnt.Core.FunctionSetBase.Project"/> that this functionset will reference.
- </value>
- </member>
- <member name="M:NAnt.Core.Functions.AssemblyFunctions.LoadFromFile(System.String)">
- <summary>
- Loads an assembly given its file name or path.
- </summary>
- <param name="assemblyFile">The name or path of the file that contains the manifest of the assembly.</param>
- <returns>
- The loaded assembly.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="assemblyFile"/> is an empty <see cref="T:System.String"/>.</exception>
- <exception cref="T:System.IO.FileNotFoundException"><paramref name="assemblyFile"/> is not found, or the module you are trying to load does not specify a filename extension.</exception>
- <exception cref="T:System.BadImageFormatException"><paramref name="assemblyFile"/> is not a valid assembly.</exception>
- <exception cref="T:System.IO.PathTooLongException">An assembly or module was loaded twice with two different evidences, or the assembly name is longer than MAX_PATH characters.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.AssemblyFunctions.Load(System.String)">
- <summary>
- Loads an assembly given the long form of its name.
- </summary>
- <param name="assemblyString">The long form of the assembly name.</param>
- <returns>
- The loaded assembly.
- </returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="assemblyString"/> is a <see langword="null"/>.</exception>
- <exception cref="T:System.IO.FileNotFoundException"><paramref name="assemblyString"/> is not found.</exception>
- <example>
- <para>
- Determine the location of the Microsoft Access 11 Primary Interop
- Assembly by loading it using its fully qualified name, and copy it
- to the build directory.
- </para>
- <code>
- <![CDATA[
- <property name="access.pia.path" value="${assembly::get-location(assembly::load('Microsoft.Office.Interop.Access, Version=11.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c'))}" />
- <copy file="${access.pia.path}" todir="${build.dir}" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.AssemblyFunctions.GetFullName(System.Reflection.Assembly)">
- <summary>
- Gets the full name of the assembly, also known as the display name.
- </summary>
- <param name="assembly">The assembly to get the full name for.</param>
- <returns>
- The full name of the assembly, also known as the display name.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)">
- <summary>
- Gets an <see cref="T:System.Reflection.AssemblyName"/> for the specified assembly.
- </summary>
- <param name="assembly">The assembly to get an <see cref="T:System.Reflection.AssemblyName"/> for.</param>
- <returns>
- An <see cref="T:System.Reflection.AssemblyName"/> for the specified assembly.
- </returns>
- <seealso cref="T:NAnt.Core.Functions.AssemblyNameFunctions"/>
- </member>
- <member name="M:NAnt.Core.Functions.AssemblyFunctions.GetLocation(System.Reflection.Assembly)">
- <summary>
- Gets the physical location, in codebase format, of the loaded file
- that contains the manifest.
- </summary>
- <param name="assembly">The assembly to get the location for.</param>
- <returns>
- The location of the specified assembly.
- </returns>
- </member>
- <member name="T:NAnt.Core.Functions.AssemblyNameFunctions">
- <summary>
- Functions that return information about an assembly's identity.
- </summary>
- </member>
- <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetCodeBase(System.Reflection.AssemblyName)">
- <summary>
- Gets the location of the assembly as a URL.
- </summary>
- <param name="assemblyName">The <see cref="T:System.Reflection.AssemblyName"/> of the assembly.</param>
- <returns>
- The location of the assembly as a URL.
- </returns>
- <seealso cref="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)"/>
- </member>
- <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetEscapedCodeBase(System.Reflection.AssemblyName)">
- <summary>
- Gets the URI, including escape characters, that represents the codebase.
- </summary>
- <param name="assemblyName">The <see cref="T:System.Reflection.AssemblyName"/> of the assembly.</param>
- <returns>
- The URI, including escape characters, that represents the codebase.
- </returns>
- <seealso cref="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)"/>
- </member>
- <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetFullName(System.Reflection.AssemblyName)">
- <summary>
- Gets the full name of the assembly, also known as the display name.
- </summary>
- <param name="assemblyName">The <see cref="T:System.Reflection.AssemblyName"/> of the assembly.</param>
- <returns>
- The full name of the assembly, also known as the display name.
- </returns>
- <example>
- <para>
- Output the full name of the <c>nunit.framework</c> assembly to the
- build log.
- </para>
- <code>
- <![CDATA[
- <echo message="${assemblyname::get-full-name(assemblyname::get-assembly-name('nunit.framework.dll'))}" />
- ]]>
- </code>
- </example>
- <seealso cref="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)"/>
- </member>
- <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetName(System.Reflection.AssemblyName)">
- <summary>
- Gets the simple, unencrypted name of the assembly.
- </summary>
- <param name="assemblyName">The <see cref="T:System.Reflection.AssemblyName"/> of the assembly.</param>
- <returns>
- The simple, unencrypted name of the assembly.
- </returns>
- <example>
- <para>
- Output the simple name of the <c>nunit.framework</c> assembly to
- the build log.
- </para>
- <code>
- <![CDATA[
- <echo message="${assemblyname::get-name(assemblyname::get-assembly-name('nunit.framework.dll'))}" />
- ]]>
- </code>
- </example>
- <seealso cref="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)"/>
- </member>
- <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)">
- <summary>
- Gets the version of the assembly.
- </summary>
- <param name="assemblyName">The <see cref="T:System.Reflection.AssemblyName"/> of the assembly.</param>
- <returns>
- The version of the assembly.
- </returns>
- <example>
- <para>
- Output the major version of the <c>nunit.framework</c> assembly
- to the build log.
- </para>
- <code>
- <![CDATA[
- <echo message="${version::get-major-version(assemblyname::get-version(assemblyname::get-assembly-name('nunit.framework.dll')))}" />
- ]]>
- </code>
- </example>
- <seealso cref="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)"/>
- <seealso cref="T:NAnt.Core.Functions.VersionFunctions"/>
- </member>
- <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetAssemblyName(System.String)">
- <summary>
- Gets the <see cref="T:System.Reflection.AssemblyName"/> for a given file.
- </summary>
- <param name="assemblyFile">The assembly file for which to get the <see cref="T:System.Reflection.AssemblyName"/>.</param>
- <returns>
- An <see cref="T:System.Reflection.AssemblyName"/> object representing the given file.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="assemblyFile"/> is an empty <see cref="T:System.String"/>.</exception>
- <exception cref="T:System.IO.FileNotFoundException"><paramref name="assemblyFile"/> does not exist.</exception>
- <exception cref="T:System.BadImageFormatException"><paramref name="assemblyFile"/> is not a valid assembly.</exception>
- <remarks>
- The assembly is not added to this domain.
- </remarks>
- <example>
- <para>
- Output the full name of the <c>nunit.framework</c> assembly to the
- build log.
- </para>
- <code>
- <![CDATA[
- <echo message="${assemblyname::get-full-name(assemblyname::get-assembly-name('nunit.framework.dll'))}" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.BooleanConversionFunctions.Parse(System.String)">
- <summary>
- Converts the specified string representation of a logical value to
- its <see cref="T:System.Boolean"/> equivalent.
- </summary>
- <param name="s">A string containing the value to convert.</param>
- <returns>
- <see langword="true"/> if <paramref name="value"/> is equivalent to
- "True"; otherwise, <see langword="false"/>.
- </returns>
- <exception cref="T:System.FormatException"><paramref name="s"/> is not equivalent to <see cref="F:System.Boolean.TrueString"/> or <see cref="F:System.Boolean.FalseString"/>.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.BooleanConversionFunctions.ToString(System.Boolean)">
- <summary>
- Converts the specified <see cref="T:System.Boolean"/> to its equivalent string
- representation.
- </summary>
- <param name="value">A <see cref="T:System.Boolean"/> to convert.</param>
- <returns>
- "True" if <paramref name="value"/> is <see langword="true"/>, or
- "False" if <paramref name="value"/> is <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.ConversionFunctions.ToInt(System.Int32)">
- <summary>
- Converts the argument to an integer.
- </summary>
- <param name="value">value to be converted</param>
- <returns><paramref name="value" /> converted to integer. The function fails with an exception when the conversion is not possible.</returns>
- </member>
- <member name="M:NAnt.Core.Functions.ConversionFunctions.ToDouble(System.Double)">
- <summary>
- Converts the argument to double
- </summary>
- <param name="value">The value to be converted.</param>
- <returns><paramref name="value" /> converted to double. The function fails with an exception when the conversion is not possible.</returns>
- </member>
- <member name="M:NAnt.Core.Functions.ConversionFunctions.ConvertToString(System.String)">
- <summary>
- Converts the argument to a string.
- </summary>
- <param name="value">The value to be converted.</param>
- <returns>
- <paramref name="value" /> converted to string. The function fails
- with an exception when the conversion is not possible.
- </returns>
- <remarks>
- Named method ConvertToString as a static ToString method would break
- CLS compliance.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Functions.ConversionFunctions.ToDateTime(System.DateTime)">
- <summary>
- Converts the argument to a datetime.
- </summary>
- <param name="value">value to be converted</param>
- <returns><paramref name="value" /> converted to datetime. The function fails with an exception when the conversion is not possible.</returns>
- </member>
- <member name="M:NAnt.Core.Functions.ConversionFunctions.ToBoolean(System.Boolean)">
- <summary>
- Converts the argument to a boolean
- </summary>
- <param name="value">The string value to be converted to boolean. Must be 'true' or 'false'.</param>
- <returns>
- <paramref name="value" /> converted to boolean. The function fails
- with an exception when the conversion is not possible.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.DateTimeFunctions.Now">
- <summary>
- Gets a <see cref="T:System.DateTime"/> that is the current local date and
- time on this computer.
- </summary>
- <returns>
- A <see cref="T:System.DateTime"/> whose value is the current date and time.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetYear(System.DateTime)">
- <summary>
- Gets the year component of the specified date.
- </summary>
- <param name="date">The date of which to get the year component.</param>
- <returns>
- The year, between 1 and 9999.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetMonth(System.DateTime)">
- <summary>
- Gets the month component of the specified date.
- </summary>
- <param name="date">The date of which to get the month component.</param>
- <returns>
- The month, between 1 and 12.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetDay(System.DateTime)">
- <summary>
- Gets the day of the month represented by the specified date.
- </summary>
- <param name="date">The date of which to get the day of the month.</param>
- <returns>
- The day value, between 1 and 31.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetHour(System.DateTime)">
- <summary>
- Gets the hour component of the specified date.
- </summary>
- <param name="date">The date of which to get the hour component.</param>
- <returns>
- The hour, between 0 and 23.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetMinute(System.DateTime)">
- <summary>
- Gets the minute component of the specified date.
- </summary>
- <param name="date">The date of which to get the minute component.</param>
- <returns>
- The minute, between 0 and 59.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetSecond(System.DateTime)">
- <summary>
- Gets the seconds component of the specified date.
- </summary>
- <param name="date">The date of which to get the seconds component.</param>
- <returns>
- The seconds, between 0 and 59.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetMillisecond(System.DateTime)">
- <summary>
- Gets the milliseconds component of the specified date.
- </summary>
- <param name="date">The date of which to get the milliseconds component.</param>
- <returns>
- The millisecond, between 0 and 999.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetTicks(System.DateTime)">
- <summary>
- Gets the number of ticks that represent the specified date.
- </summary>
- <param name="date">The date of which to get the number of ticks.</param>
- <returns>
- The number of ticks that represent the date and time of the
- specified date.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetDayOfWeek(System.DateTime)">
- <summary>
- Gets the day of the week represented by the specified date.
- </summary>
- <param name="date">The date of which to get the day of the week.</param>
- <returns>
- The day of the week, ranging from zero, indicating Sunday, to six,
- indicating Saturday.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetDayOfYear(System.DateTime)">
- <summary>
- Gets the day of the year represented by the specified date.
- </summary>
- <param name="date">The date of which to get the day of the year.</param>
- <returns>
- The day of the year, between 1 and 366.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetDaysInMonth(System.Int32,System.Int32)">
- <summary>
- Returns the number of days in the specified month of the specified
- year.
- </summary>
- <param name="year">The year.</param>
- <param name="month">The month (a number ranging from 1 to 12).</param>
- <returns>
- The number of days in <paramref name="month"/> for the specified
- <paramref name="year"/>.
- </returns>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="month"/> is less than 1 or greater than 12.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.DateTimeFunctions.IsLeapYear(System.Int32)">
- <summary>
- Returns an indication whether the specified year is a leap year.
- </summary>
- <param name="year">A 4-digit year.</param>
- <returns>
- <see langword="true" /> if <paramref name="year" /> is a leap year;
- otherwise, <see langword="false" />.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.DateTimeConversionFunctions.Parse(System.String)">
- <summary>
- Converts the specified string representation of a date and time to
- its <see cref="T:System.DateTime"/> equivalent.
- </summary>
- <param name="s">A string containing a date and time to convert.</param>
- <returns>
- A <see cref="T:System.DateTime"/> equivalent to the date and time contained
- in <paramref name="s"/>.
- </returns>
- <exception cref="T:System.FormatException"><paramref name="s"/> does not contain a valid string representation of a date and time.</exception>
- <remarks>
- The <see cref="T:System.Globalization.DateTimeFormatInfo"/> for the invariant culture is
- used to supply formatting information about <paramref name="s"/>.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Functions.DateTimeConversionFunctions.ToString(System.DateTime)">
- <summary>
- Converts the specified <see cref="T:System.DateTime"/> to its equivalent
- string representation.
- </summary>
- <param name="value">A <see cref="T:System.DateTime"/> to convert.</param>
- <returns>
- A string representation of <paramref name="value"/> formatted using
- the general format specifier ("G").
- </returns>
- <remarks>
- <paramref name="value"/> is formatted with the
- <see cref="T:System.Globalization.DateTimeFormatInfo"/> for the invariant culture.
- </remarks>
- </member>
- <member name="T:NAnt.Core.Functions.DirectoryFunctions">
- <summary>
- Groups a set of functions for dealing with directories.
- </summary>
- </member>
- <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetCreationTime(System.String)">
- <summary>
- Returns the creation date and time of the specified directory.
- </summary>
- <param name="path">The directory for which to obtain creation date and time information.</param>
- <returns>
- The creation date and time of the specified directory.
- </returns>
- <exception cref="T:System.IO.IOException">The specified directory does not exist.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception>
- <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetLastWriteTime(System.String)">
- <summary>
- Returns the date and time the specified directory was last written to.
- </summary>
- <param name="path">The directory for which to obtain write date and time information.</param>
- <returns>
- The date and time the specified directory was last written to.
- </returns>
- <exception cref="T:System.IO.IOException">The specified directory does not exist.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception>
- <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetLastAccessTime(System.String)">
- <summary>
- Returns the date and time the specified directory was last accessed.
- </summary>
- <param name="path">The directory for which to obtain access date and time information.</param>
- <returns>
- The date and time the specified directory was last accessed.
- </returns>
- <exception cref="T:System.IO.IOException">The specified directory does not exist.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception>
- <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
- <exception cref="T:System.NotSupportedException">The <paramref name="path"/> parameter is in an invalid format.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetCurrentDirectory">
- <summary>
- Gets the current working directory.
- </summary>
- <returns>
- A <see cref="T:System.String"/> containing the path of the current working
- directory.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetParentDirectory(System.String)">
- <summary>
- Retrieves the parent directory of the specified path.
- </summary>
- <param name="path">The path for which to retrieve the parent directory.</param>
- <returns>
- The parent directory, or an empty <see cref="T:System.String"/> if
- <paramref name="path"/> is the root directory, including the root
- of a UNC server or share name.
- </returns>
- <exception cref="T:System.IO.IOException">The directory specified by <paramref name="path"/> is read-only.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception>
- <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
- <exception cref="T:System.IO.DirectoryNotFoundException">The specified path was not found.</exception>
- <example>
- <para>
- Copy "readme.txt" from the current working directory to
- its parent directory.
- </para>
- <code>
- <![CDATA[
- <property name="current.dir" value="${directory::get-current-directory()}" />
- <property name="current.dir.parent" value="${directory::get-parent-directory(current.dir)}" />
- <copy file="${path::combine(current.dir, 'readme.txt')} todir="${current.dir.parent}" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetDirectoryRoot(System.String)">
- <summary>
- Returns the volume information, root information, or both for the
- specified path.
- </summary>
- <param name="path">The path for which to retrieve the parent directory.</param>
- <returns>
- A string containing the volume information, root information, or
- both for the specified path.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception>
- <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.DirectoryFunctions.Exists(System.String)">
- <summary>
- Determines whether the given path refers to an existing directory
- on disk.
- </summary>
- <param name="path">The path to test.</param>
- <returns>
- <see langword="true" /> if <paramref name="path" /> refers to an
- existing directory; otherwise, <see langword="false" />.
- </returns>
- <example>
- <para>Remove directory "test", if it exists.</para>
- <code>
- <![CDATA[
- <delete dir="test" if="${directory::exists('test')}" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.DoubleConversionFunctions.Parse(System.String)">
- <summary>
- Converts the specified string representation of a number to its
- double-precision floating point number equivalent.
- </summary>
- <param name="s">A string containing a number to convert.</param>
- <returns>
- A double-precision floating point number equivalent to the numeric
- value or symbol specified in <paramref name="s"/>.
- </returns>
- <exception cref="T:System.FormatException"><paramref name="s"/> is not a number in a valid format.</exception>
- <exception cref="T:System.OverflowException"><paramref name="s"/> represents a number less than <see cref="F:System.Double.MinValue"/> or greater than <see cref="F:System.Double.MaxValue"/>.</exception>
- <remarks>
- The <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture is
- used to supply formatting information about <paramref name="s"/>.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Functions.DoubleConversionFunctions.ToString(System.Double)">
- <summary>
- Converts the specified <see cref="T:System.Double"/> to its equivalent
- string representation.
- </summary>
- <param name="value">A <see cref="T:System.Double"/> to convert.</param>
- <returns>
- The string representation of <paramref name="value"/> formatted
- using the general format specifier ("G").
- </returns>
- <remarks>
- <paramref name="value"/> is formatted with the
- <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture.
- </remarks>
- </member>
- <member name="T:NAnt.Core.Functions.EnvironmentFunctions">
- <summary>
- Provide information about the current environment and platform.
- </summary>
- </member>
- <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetFolderPath(System.Environment.SpecialFolder)">
- <summary>
- Gets the path to the system special folder identified by the
- specified enumeration.
- </summary>
- <param name="folder">An enumerated constant that identifies a system special folder.</param>
- <returns>
- The path to the specified system special folder, if that folder
- physically exists on your computer; otherwise, the empty string ("").
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="folder"/> is not a member of <see cref="T:System.Environment.SpecialFolder"/>.</exception>
- <example>
- <para>
- Copy "out.log" from the project base directory to the
- program files directory.
- </para>
- <code>
- <![CDATA[
- <copy file="out.log" todir="${environment::get-folder-path('ProgramFiles')}" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetMachineName">
- <summary>
- Gets the NetBIOS name of this local computer.
- </summary>
- <returns>
- The NetBIOS name of this local computer.
- </returns>
- <exception cref="T:System.InvalidOperationException">The name of this computer cannot be obtained.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetOperatingSystem">
- <summary>
- Gets an <see cref="T:System.OperatingSystem"/> object that represents the
- current operating system.
- </summary>
- <returns>
- An <see cref="T:System.OperatingSystem"/> object that contains the current
- platform identifier and version number.
- </returns>
- <example>
- <para>
- Output string representation of the current operating system.
- </para>
- <code>
- <![CDATA[
- <echo message="OS=${operating-system::to-string(environment::get-operating-system())}" />
- ]]>
- </code>
- <para>If the operating system is Windows 2000, the output is:</para>
- <code>
- Microsoft Windows NT 5.0.2195.0
- </code>
- </example>
- <seealso cref="T:NAnt.Core.Functions.OperatingSystemFunctions"/>
- </member>
- <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetUserName">
- <summary>
- Gets the user name of the person who started the current thread.
- </summary>
- <returns>
- The name of the person logged on to the system who started the
- current thread.
- </returns>
- <example>
- <para>
- Modify the home directory of the current user on unix-based systems.
- </para>
- <code>
- <![CDATA[
- <exec program="usermod">
- <arg value="-d" />
- <arg value="/home/temp" />
- <arg value="${environment::get-user-name()}" />
- </exec>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetVariable(System.String)">
- <summary>
- Returns the value of the specified environment variable.
- </summary>
- <param name="name">The environment variable of which the value should be returned.</param>
- <returns>
- The value of the specified environment variable.
- </returns>
- <exception cref="T:System.ArgumentException">Environment variable <paramref name="name"/> does not exist.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.EnvironmentFunctions.VariableExists(System.String)">
- <summary>
- Gets a value indicating whether the specified environment variable
- exists.
- </summary>
- <param name="name">The environment variable that should be checked.</param>
- <returns>
- <see langword="true" /> if the environment variable exists; otherwise,
- <see langword="false" />.
- </returns>
- <example>
- <para>
- Execute a set of tasks only if the "BUILD_DEBUG" environment
- variable is set.
- </para>
- <code>
- <![CDATA[
- <if test="${environment::variable-exists('BUILD_DEBUG')}">
- ...
- </if>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion">
- <summary>
- Gets a <see cref="T:System.Version"/> object that describes the major,
- minor, build, and revision numbers of the Common Language Runtime.
- </summary>
- <returns>
- A Version object.
- </returns>
- <example>
- <para>Output the major version of the CLR.</para>
- <code>
- <![CDATA[
- <echo message="Major version=${version::get-major(environment::get-version())}" />
- ]]>
- </code>
- </example>
- </member>
- <member name="T:NAnt.Core.Functions.FileFunctions">
- <summary>
- Groups a set of functions for dealing with files.
- </summary>
- </member>
- <member name="M:NAnt.Core.Functions.FileFunctions.GetCreationTime(System.String)">
- <summary>
- Returns the creation date and time of the specified file.
- </summary>
- <param name="path">The file for which to obtain creation date and time information.</param>
- <returns>
- The creation date and time of the specified file.
- </returns>
- <exception cref="T:System.IO.IOException">The specified file does not exist.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception>
- <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
- <exception cref="T:System.NotSupportedException">The <paramref name="path"/> parameter is in an invalid format.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.FileFunctions.GetLastWriteTime(System.String)">
- <summary>
- Returns the date and time the specified file was last written to.
- </summary>
- <param name="path">The file for which to obtain write date and time information.</param>
- <returns>
- The date and time the specified file was last written to.
- </returns>
- <exception cref="T:System.IO.IOException">The specified file does not exist.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception>
- <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.FileFunctions.GetLastAccessTime(System.String)">
- <summary>
- Returns the date and time the specified file was last accessed.
- </summary>
- <param name="path">The file for which to obtain access date and time information.</param>
- <returns>
- The date and time the specified file was last accessed.
- </returns>
- <exception cref="T:System.IO.IOException">The specified file does not exist.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception>
- <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
- <exception cref="T:System.NotSupportedException">The <paramref name="path"/> parameter is in an invalid format.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.FileFunctions.Exists(System.String)">
- <summary>
- Determines whether the specified file exists.
- </summary>
- <param name="file">The file to check.</param>
- <returns>
- <see langword="true" /> if <paramref name="file" /> refers to an
- existing file; otherwise, <see langword="false" />.
- </returns>
- <example>
- <para>Execute a set of tasks, if file "output.xml" does not exist.</para>
- <code>
- <![CDATA[
- <if test="${not file::exists('output.xml')}">
- ...
- </if>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.FileFunctions.UpToDate(System.String,System.String)">
- <summary>
- Determines whether <paramref name="targetFile"/> is more or equal
- up-to-date than <paramref name="srcFile"/>.
- </summary>
- <param name="srcFile">The file to check against the target file.</param>
- <param name="targetFile">The file for which we want to determine the status.</param>
- <returns>
- <see langword="true"/> if <paramref name="targetFile"/> is more
- or equal up-to-date than <paramref name="srcFile"/>; otherwise,
- <see langword="false"/>.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="srcFile"/> or <paramref name="targetFile"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception>
- <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both of either <paramref name="srcFile"/> or <paramref name="targetFile"/> exceed the system-defined maximum length.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.FileFunctions.GetLength(System.String)">
- <summary>
- Gets the length of the file.
- </summary>
- <param name="file">filename</param>
- <returns>
- Length in bytes, of the file named <paramref name="file"/>.
- </returns>
- <exception cref="T:System.IO.FileNotFoundException">The file specified cannot be found.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.FileFunctions.IsAssembly(System.String)">
- <summary>
- Checks if a given file is an assembly.
- </summary>
- <param name="assemblyFile">The name or path of the file to be checked.</param>
- <returns>True if the file is a valid assembly, false if it's not or if the assembly seems corrupted (invalid headers or metadata).</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="assemblyFile"/> is a null <see cref="T:System.String"/>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="assemblyFile"/> is an empty <see cref="T:System.String"/>.</exception>
- <exception cref="T:System.IO.FileNotFoundException"><paramref name="assemblyFile"/> is not found, or the file you are trying to check does not specify a filename extension.</exception>
- <exception cref="T:System.Security.SecurityException">The caller does not have path discovery permission.</exception>
- </member>
- <member name="T:NAnt.Core.Functions.FileVersionInfoFunctions">
- <summary>
- Functions that provide version information for a physical file on disk.
- </summary>
- </member>
- <member name="M:NAnt.Core.Functions.FileVersionInfoFunctions.GetVersionInfo(System.String)">
- <summary>
- Returns a <see cref="T:System.Diagnostics.FileVersionInfo"/> representing the version
- information associated with the specified file.
- </summary>
- <param name="fileName">The file to retrieve the version information for.</param>
- <returns>
- A <see cref="T:System.Diagnostics.FileVersionInfo"/> containing information about the file.
- </returns>
- <exception cref="T:System.IO.FileNotFoundException">The file specified cannot be found.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.FileVersionInfoFunctions.GetCompanyName(System.Diagnostics.FileVersionInfo)">
- <summary>
- Gets the name of the company that produced the file.
- </summary>
- <param name="fileVersionInfo">A <see cref="T:System.Diagnostics.FileVersionInfo"/> instance containing version information about a file.</param>
- <returns>
- The name of the company that produced the file.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.FileVersionInfoFunctions.GetFileVersion(System.Diagnostics.FileVersionInfo)">
- <summary>
- Gets the file version of a file.
- </summary>
- <param name="fileVersionInfo">A <see cref="T:System.Diagnostics.FileVersionInfo"/> instance containing version information about a file.</param>
- <returns>
- The file version of a file.
- </returns>
- <see cref="T:NAnt.Core.Functions.VersionFunctions"/>
- </member>
- <member name="M:NAnt.Core.Functions.FileVersionInfoFunctions.GetProductName(System.Diagnostics.FileVersionInfo)">
- <summary>
- Gets the name of the product the file is distributed with.
- </summary>
- <param name="fileVersionInfo">A <see cref="T:System.Diagnostics.FileVersionInfo"/> instance containing version information about a file.</param>
- <returns>
- The name of the product the file is distributed with.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.FileVersionInfoFunctions.GetProductVersion(System.Diagnostics.FileVersionInfo)">
- <summary>
- Gets the product version of a file.
- </summary>
- <param name="fileVersionInfo">A <see cref="T:System.Diagnostics.FileVersionInfo"/> instance containing version information about a file.</param>
- <returns>
- The product version of a file.
- </returns>
- <see cref="T:NAnt.Core.Functions.VersionFunctions"/>
- </member>
- <member name="M:NAnt.Core.Functions.Int32ConversionFunctions.Parse(System.String)">
- <summary>
- Converts the specified string representation of a number to its
- 32-bit signed integer equivalent.
- </summary>
- <param name="s">A string containing a number to convert.</param>
- <returns>
- A 32-bit signed integer equivalent to the number contained in
- <paramref name="s"/>.
- </returns>
- <exception cref="T:System.FormatException"><paramref name="s"/> is not of the correct format.</exception>
- <exception cref="T:System.OverflowException"><paramref name="s"/> represents a number less than <see cref="F:System.Int32.MinValue"/> or greater than <see cref="F:System.Int32.MaxValue"/>.</exception>
- <remarks>
- The <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture is
- used to supply formatting information about <paramref name="s"/>.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Functions.Int32ConversionFunctions.ToString(System.Int32)">
- <summary>
- Converts the specified <see cref="T:System.Int32"/> to its equivalent string
- representation.
- </summary>
- <param name="value">A <see cref="T:System.Int32"/> to convert.</param>
- <returns>
- The string representation of <paramref name="value"/>, consisting
- of a negative sign if the value is negative, and a sequence of
- digits ranging from 0 to 9 with no leading zeroes.
- </returns>
- <remarks>
- <paramref name="value"/> is formatted with the
- <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Functions.Int64ConversionFunctions.Parse(System.String)">
- <summary>
- Converts the specified string representation of a number to its
- 64-bit signed integer equivalent.
- </summary>
- <param name="s">A string containing a number to convert.</param>
- <returns>
- A 64-bit signed integer equivalent to the number contained in
- <paramref name="s"/>.
- </returns>
- <exception cref="T:System.FormatException"><paramref name="s"/> is not of the correct format.</exception>
- <exception cref="T:System.OverflowException"><paramref name="s"/> represents a number less than <see cref="F:System.Int64.MinValue"/> or greater than <see cref="F:System.Int64.MaxValue"/>.</exception>
- <remarks>
- The <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture is
- used to supply formatting information about <paramref name="s"/>.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Functions.Int64ConversionFunctions.ToString(System.Int64)">
- <summary>
- Converts the specified <see cref="T:System.Int64"/> to its equivalent string
- representation.
- </summary>
- <param name="value">A <see cref="T:System.Int64"/> to convert.</param>
- <returns>
- The string representation of <paramref name="value"/>, consisting
- of a negative sign if the value is negative, and a sequence of
- digits ranging from 0 to 9 with no leading zeroes.
- </returns>
- <remarks>
- <paramref name="value"/> is formatted with the
- <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Functions.MathFunctions.Round(System.Double)">
- <summary>
- Rounds the value to the nearest whole number
- </summary>
- <param name="value">Number to be rounded, can be anything convertible to a double.</param>
- <returns>
- Rounded value.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.MathFunctions.Floor(System.Double)">
- <summary>
- Returns the largest whole number less than or equal to the specified
- number.
- </summary>
- <param name="value">value to be , can be anything convertible to a double</param>
- <returns>
- The largest whole number less than or equal to the specified number.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.MathFunctions.Ceiling(System.Double)">
- <summary>
- Returns the smallest whole number greater than or equal to the specified number
- </summary>
- <param name="value">value</param>
- <returns>
- The smallest whole number greater than or equal to the specified number.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.MathFunctions.Abs(System.Double)">
- <summary>
- Returns the absolute value of the specified number
- </summary>
- <param name="value">value to take the absolute value from</param>
- <returns>
- <paramref name="value" /> when <paramref name="value" /> is greater
- than or equal to zero; otherwise, -<paramref name="value" />.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.NAntFunctions.GetBaseDirectory">
- <summary>
- Gets the base directory of the appdomain in which NAnt is running.
- </summary>
- <returns>
- The base directory of the appdomain in which NAnt is running.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.NAntFunctions.GetAssembly">
- <summary>
- Gets the NAnt assembly.
- </summary>
- <returns>
- The NAnt assembly.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.ProjectFunctions.GetName">
- <summary>
- Gets the name of the current project.
- </summary>
- <returns>
- The name of the current project, or an empty <see cref="T:System.String"/>
- if no name is specified in the build file.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.ProjectFunctions.GetBuildFileUri">
- <summary>
- Gets the <see cref="T:System.Uri"/> form of the build file.
- </summary>
- <returns>
- The <see cref="T:System.Uri"/> form of the build file, or
- an empty <see cref="T:System.String"/> if the project is not file backed.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.ProjectFunctions.GetBuildFilePath">
- <summary>
- Gets the local path to the build file.
- </summary>
- <returns>
- The local path of the build file, or an empty <see cref="T:System.String"/>
- if the project is not file backed.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.ProjectFunctions.GetDefaultTarget">
- <summary>
- Gets the name of the target that will be executed when no other
- build targets are specified.
- </summary>
- <returns>
- The name of the target that will be executed when no other build
- targets are specified, or an empty <see cref="T:System.String"/> if no
- default target is defined for the project.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.ProjectFunctions.GetBaseDirectory">
- <summary>
- Gets the base directory of the current project.
- </summary>
- <returns>
- The base directory of the current project.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.TargetFunctions.Exists(System.String)">
- <summary>
- Checks whether the specified target exists.
- </summary>
- <param name="name">The target to test.</param>
- <returns>
- <see langword="true" /> if the specified target exists; otherwise,
- <see langword="false" />.
- </returns>
- <example>
- <para>
- Execute target "clean", if it exists.
- </para>
- <code>
- <![CDATA[
- <if test="${target::exists('clean')}">
- <call target="clean" />
- </if>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.TargetFunctions.GetCurrentTarget">
- <summary>
- Gets the name of the target being executed.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that contains the name of the target
- being executed.
- </returns>
- <exception cref="T:System.InvalidOperationException">No target is being executed.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.TargetFunctions.HasExecuted(System.String)">
- <summary>
- Checks whether the specified target has already been executed.
- </summary>
- <param name="name">The target to test.</param>
- <returns>
- <see langword="true"/> if the specified target has already been
- executed; otherwise, <see langword="false"/>.
- </returns>
- <exception cref="T:System.ArgumentException">Target <paramref name="name"/> does not exist.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.TaskFunctions.Exists(System.String)">
- <summary>
- Checks whether the specified task exists.
- </summary>
- <param name="name">The task to test.</param>
- <returns>
- <see langword="true" /> if the specified task exists; otherwise,
- <see langword="false" />.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.TaskFunctions.GetAssembly(System.String)">
- <summary>
- Returns the <see cref="T:System.Reflection.Assembly"/> from which the specified task
- was loaded.
- </summary>
- <param name="name">The name of the task to get the <see cref="T:System.Reflection.Assembly"/> of.</param>
- <returns>
- The <see cref="T:System.Reflection.Assembly"/> from which the specified task was loaded.
- </returns>
- <exception cref="T:System.ArgumentException">Task <paramref name="name"/> is not available.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PropertyFunctions.Exists(System.String)">
- <summary>
- Checks whether the specified property exists.
- </summary>
- <param name="name">The property to test.</param>
- <returns>
- <see langword="true" /> if the specified property exists; otherwise,
- <see langword="false" />.
- </returns>
- <example>
- <para>
- Execute a set of tasks if the "build.debug" property
- exists.
- </para>
- <code>
- <![CDATA[
- <if test="${property::exists('build.debug')}">
- <echo message="Starting debug build" />
- <call target="init-debug" />
- <call target="build" />
- </if>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.PropertyFunctions.IsReadOnly(System.String)">
- <summary>
- Checks whether the specified property is read-only.
- </summary>
- <param name="name">The property to test.</param>
- <returns>
- <see langword="true"/> if the specified property is read-only;
- otherwise, <see langword="false"/>.
- </returns>
- <example>
- <para>Check whether the "debug" property is read-only.</para>
- <code>property::is-readonly('debug')</code>
- </example>
- <exception cref="T:System.ArgumentException">Property <paramref name="name"/> has not been set.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PropertyFunctions.IsDynamic(System.String)">
- <summary>
- Checks whether the specified property is a dynamic property.
- </summary>
- <param name="name">The property to test.</param>
- <returns>
- <see langword="true"/> if the specified property is a dynamic
- property; otherwise, <see langword="false"/>.
- </returns>
- <exception cref="T:System.ArgumentException">Property <paramref name="name"/> has not been set.</exception>
- <example>
- <para>
- Check whether the "debug" property is a dynamic property.
- </para>
- <code>property::is-dynamic('debug')</code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.FrameworkFunctions.Exists(System.String)">
- <summary>
- Checks whether the specified framework exists.
- </summary>
- <param name="name">The framework to test.</param>
- <returns>
- <see langword="true" /> if the specified framework exists; otherwise,
- <see langword="false" />.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.FrameworkFunctions.SdkExists(System.String)">
- <summary>
- Checks whether the SDK for the specified framework is installed.
- </summary>
- <param name="name">The framework to test.</param>
- <returns>
- <see langword="true"/> if the SDK for specified framework is installed;
- otherwise, <see langword="false"/>.
- </returns>
- <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
- <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
- </member>
- <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework">
- <summary>
- Gets the identifier of the current target framework.
- </summary>
- <returns>
- The identifier of the current target framework.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework">
- <summary>
- Gets the identifier of the runtime framework.
- </summary>
- <returns>
- The identifier of the runtime framework.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetFamily(System.String)">
- <summary>
- Gets the family of the specified framework.
- </summary>
- <param name="framework">The framework of which the family should be returned.</param>
- <returns>
- The family of the specified framework.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
- <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
- <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
- </member>
- <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetVersion(System.String)">
- <summary>
- Gets the version of the specified framework.
- </summary>
- <param name="framework">The framework of which the version should be returned.</param>
- <returns>
- The version of the specified framework.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
- <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
- <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
- </member>
- <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetDescription(System.String)">
- <summary>
- Gets the description of the specified framework.
- </summary>
- <param name="framework">The framework of which the description should be returned.</param>
- <returns>
- The description of the specified framework.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
- <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
- <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
- </member>
- <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetClrVersion(System.String)">
- <summary>
- Gets the Common Language Runtime version of the specified framework.
- </summary>
- <param name="framework">The framework of which the Common Language Runtime version should be returned.</param>
- <returns>
- The Common Language Runtime version of the specified framework.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
- <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
- <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
- </member>
- <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetFrameworkDirectory(System.String)">
- <summary>
- Gets the framework directory of the specified framework.
- </summary>
- <param name="framework">The framework of which the framework directory should be returned.</param>
- <returns>
- The framework directory of the specified framework.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
- <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
- <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
- </member>
- <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetAssemblyDirectory(System.String)">
- <summary>
- Gets the assembly directory of the specified framework.
- </summary>
- <param name="framework">The framework of which the assembly directory should be returned.</param>
- <returns>
- The assembly directory of the specified framework.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
- <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
- <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
- </member>
- <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetSdkDirectory(System.String)">
- <summary>
- Gets the SDK directory of the specified framework.
- </summary>
- <param name="framework">The framework of which the SDK directory should be returned.</param>
- <returns>
- The SDK directory of the specified framework, or an empty
- <see cref="T:System.String"/> if the SDK of the specified framework is not
- installed.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
- <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
- <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
- </member>
- <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeEngine(System.String)">
- <summary>
- Gets the runtime engine of the specified framework.
- </summary>
- <param name="framework">The framework of which the runtime engine should be returned.</param>
- <returns>
- The full path to the runtime engine of the specified framework, or
- an empty <see cref="T:System.String"/> if no runtime engine is defined
- for the specified framework.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
- <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
- <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
- </member>
- <member name="M:NAnt.Core.Functions.FrameworkFunctions.CheckFramework(System.String)">
- <summary>
- Checks whether the specified framework is valid.
- </summary>
- <param name="framework">The framework to check.</param>
- <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PlatformFunctions.GetName">
- <summary>
- Gets the name of the platform on which NAnt is running.
- </summary>
- <returns>
- The name of the platform on which NAnt is running.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.PlatformFunctions.IsWin32">
- <summary>
- Checks whether NAnt is running on the win32 platform.
- </summary>
- <returns>
- <see langword="true" /> if NAnt is running on the win32 platform;
- otherwise, <see langword="false" />.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.PlatformFunctions.IsUnix">
- <summary>
- Checks whether NAnt is running on unix.
- </summary>
- <returns>
- <see langword="true" /> if NAnt is running on unix;
- otherwise, <see langword="false" />.
- </returns>
- </member>
- <member name="T:NAnt.Core.Functions.OperatingSystemFunctions">
- <summary>
- Functions that return information about an operating system.
- </summary>
- </member>
- <member name="M:NAnt.Core.Functions.OperatingSystemFunctions.GetPlatform(System.OperatingSystem)">
- <summary>
- Gets a <see cref="T:System.PlatformID"/> value that identifies the operating
- system platform.
- </summary>
- <param name="operatingSystem">The operating system.</param>
- <returns>
- <see cref="T:System.PlatformID"/> value that identifies the operating system
- platform.
- </returns>
- <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetOperatingSystem"/>
- </member>
- <member name="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)">
- <summary>
- Gets a <see cref="T:System.Version"/> object that identifies this operating
- system.
- </summary>
- <param name="operatingSystem">The operating system.</param>
- <returns>
- A <see cref="T:System.Version"/> object that describes the major version,
- minor version, build, and revision of the operating system.
- </returns>
- <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetOperatingSystem"/>
- </member>
- <member name="M:NAnt.Core.Functions.OperatingSystemFunctions.ToString(System.OperatingSystem)">
- <summary>
- Converts the value of the specified operating system to its equivalent
- <see cref="T:System.String"/> representation.
- </summary>
- <param name="operatingSystem">The operating system.</param>
- <returns>
- The <see cref="T:System.String"/> representation of
- <paramref name="operatingSystem"/>.
- </returns>
- <example>
- <para>
- Output string representation of the current operating system.
- </para>
- <code>
- <![CDATA[
- <echo message="OS=${operating-system::to-string(environment::get-operating-system())}" />
- ]]>
- </code>
- <para>If the operating system is Windows 2000, the output is:</para>
- <code>
- Microsoft Windows NT 5.0.2195.0
- </code>
- </example>
- <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetOperatingSystem"/>
- </member>
- <member name="M:NAnt.Core.Functions.PathFunctions.GetFullPath(System.String)">
- <summary>
- Returns the fully qualified path.
- </summary>
- <param name="path">The file or directory for which to obtain absolute path information.</param>
- <returns>
- A string containing the fully qualified location of <paramref name="path"/>,
- such as "C:\MyFile.txt".
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception>
- <exception cref="T:System.NotSupportedException"><paramref name="path"/> contains a colon (":").</exception>
- <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PathFunctions.Combine(System.String,System.String)">
- <summary>
- Combines two paths.
- </summary>
- <param name="path1">first path</param>
- <param name="path2">second path</param>
- <returns>
- A string containing the combined paths. If one of the specified paths
- is a zero-length string, this method returns the other path. If
- <paramref name="path2"/> contains an absolute path, this method
- returns <paramref name="path2"/>.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="path1"/> or <paramref name="path2"/> contain one or more invalid characters.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PathFunctions.ChangeExtension(System.String,System.String)">
- <summary>
- Changes the extension of the path string.
- </summary>
- <param name="path">The path information to modify. The path cannot contain any of the characters
- defined in <see cref="F:System.IO.Path.InvalidPathChars"/>InvalidPathChars.</param>
- <param name="extension">The new extension (with a leading period). Specify a null reference
- to remove an existing extension from <paramref name="path"/>.</param>
- <returns>
- <para>
- A string containing the modified path information.
- </para>
- <para>
- On Windows-based desktop platforms, if <paramref name="path"/> is
- an empty <see cref="T:System.String"/>, the path information is returned
- unmodified. If <paramref name="path"/> has no extension, the returned
- path <see cref="T:System.String"/> contains <paramref name="extension"/>
- appended to the end of <paramref name="path"/>.
- </para>
- </returns>
- <remarks>
- For more information see the <see cref="T:System.IO.Path"/> documentation.
- </remarks>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PathFunctions.GetDirectoryName(System.String)">
- <summary>
- Returns the directory information for the specified path string.
- </summary>
- <param name="path">The path of a file or directory.</param>
- <returns>
- A <see cref="T:System.String"/> containing directory information for
- <paramref name="path"/>, or an empty <see cref="T:System.String"/> if
- <paramref name="path"/> denotes a root directory, or does not
- contain directory information.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> contains invalid characters, is empty, or contains only white spaces.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PathFunctions.GetExtension(System.String)">
- <summary>
- Returns the extension for the specified path string.
- </summary>
- <param name="path">The path string from which to get the extension.</param>
- <returns>
- A <see cref="T:System.String"/> containing the extension of the specified
- <paramref name="path"/> (including the "."), or an empty
- <see cref="T:System.String"/> if <paramref name="path"/> does not have
- extension information.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PathFunctions.GetFileName(System.String)">
- <summary>
- Returns the filename for the specified path string.
- </summary>
- <param name="path">The path string from which to obtain the file name and extension.</param>
- <returns>
- <para>
- A <see cref="T:System.String"/> consisting of the characters after the last
- directory character in path.
- </para>
- <para>
- If the last character of <paramref name="path"/> is a directory or
- volume separator character, an empty <see cref="T:System.String"/> is returned.
- </para>
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PathFunctions.GetFileNameWithoutExtension(System.String)">
- <summary>
- Returns the filename without extension for the specified path string.
- </summary>
- <param name="path">The path of the file.</param>
- <returns>
- A <see cref="T:System.String"/> containing the <see cref="T:System.String"/> returned
- by <see cref="M:NAnt.Core.Functions.PathFunctions.GetFileName(System.String)"/>, minus the last period (.) and all
- characters following it.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PathFunctions.GetPathRoot(System.String)">
- <summary>
- Gets the root directory of the specified path.
- </summary>
- <param name="path">The path from which to obtain root directory information.</param>
- <returns>
- A <see cref="T:System.String"/> containing the root directory of
- <paramref name="path"/>, such as "C:\", or an empty <see cref="T:System.String"/>
- if <paramref name="path"/> does not contain root directory information.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> contains invalid characters, or is empty.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PathFunctions.GetTempFileName">
- <summary>
- Returns a uniquely named zero-byte temporary file on disk and returns the full path to that file.
- </summary>
- <returns>
- A <see cref="T:System.String"/> containing the name of the temporary file.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.PathFunctions.GetTempPath">
- <summary>
- Gets the path to the temporary directory.
- </summary>
- <returns>
- A <see cref="T:System.String"/> containing the path information of a
- temporary directory.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.PathFunctions.HasExtension(System.String)">
- <summary>
- Determines whether a path string includes an extension.
- </summary>
- <param name="path">The path to search for an extension.</param>
- <returns>
- <see langword="true"/>. if the characters that follow the last
- directory separator or volume separator in the <paramref name="path"/>
- include a period (.) followed by one or more characters;
- otherwise, <see langword="false"/>.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PathFunctions.IsPathRooted(System.String)">
- <summary>
- Determines whether a path string is absolute.
- </summary>
- <param name="path">The path to test.</param>
- <returns>
- <see langword="true"/> if path contains an absolute <paramref name="path"/>;
- otherwise, <see langword="false"/>.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PkgConfigFunctions.GetVariable(System.String,System.String)">
- <summary>
- Gets the value of a variable for the specified package.
- </summary>
- <param name="package">The package for which the variable should be retrieved.</param>
- <param name="name">The name of the variable.</param>
- <returns>
- The value of variable <paramref name="name"/> for the specified
- package.
- </returns>
- <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="package"/> does not exist.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PkgConfigFunctions.GetLinkFlags(System.String)">
- <summary>
- Gets the link flags required to compile the package, including all
- its dependencies.
- </summary>
- <param name="package">The package for which the link flags should be retrieved.</param>
- <returns>
- The link flags required to compile the package.
- </returns>
- <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="package"/> does not exist.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PkgConfigFunctions.GetCompileFlags(System.String)">
- <summary>
- Gets the compile flags required to compile the package, including all
- its dependencies.
- </summary>
- <param name="package">The package for which the compile flags should be retrieved.</param>
- <returns>
- The pre-processor and compile flags required to compile the package.
- </returns>
- <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="package"/> does not exist.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PkgConfigFunctions.GetModVersion(System.String)">
- <summary>
- Determines the version of the given package.
- </summary>
- <param name="package">The package to get the version of.</param>
- <returns>
- The version of the given package.
- </returns>
- <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="package"/> does not exist.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PkgConfigFunctions.IsAtLeastVersion(System.String,System.String)">
- <summary>
- Determines whether the given package is at least version
- <paramref name="version"/>.
- </summary>
- <param name="package">The package to check.</param>
- <param name="version">The version the package should at least have.</param>
- <returns>
- <see langword="true"/> if the given package is at least version
- <paramref name="version"/>; otherwise, <see langword="false"/>.
- </returns>
- <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PkgConfigFunctions.IsExactVersion(System.String,System.String)">
- <summary>
- Determines whether the given package is exactly version
- <paramref name="version"/>.
- </summary>
- <param name="package">The package to check.</param>
- <param name="version">The version the package should have.</param>
- <returns>
- <see langword="true"/> if the given package is exactly version
- <paramref name="version"/>; otherwise, <see langword="false"/>.
- </returns>
- <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PkgConfigFunctions.IsMaxVersion(System.String,System.String)">
- <summary>
- Determines whether the given package is at no newer than version
- <paramref name="version"/>.
- </summary>
- <param name="package">The package to check.</param>
- <param name="version">The version the package should maximum have.</param>
- <returns>
- <see langword="true"/> if the given package is at no newer than
- version <paramref name="version"/>; otherwise, <see langword="false"/>.
- </returns>
- <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PkgConfigFunctions.IsBetweenVersion(System.String,System.String,System.String)">
- <summary>
- Determines whether the given package is between two versions.
- </summary>
- <param name="package">The package to check.</param>
- <param name="minVersion">The version the package should at least have.</param>
- <param name="maxVersion">The version the package should maximum have.</param>
- <returns>
- <see langword="true"/> if the given package is between <paramref name="minVersion"/>
- and <paramref name="maxVersion"/>; otherwise, <see langword="false"/>.
- </returns>
- <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PkgConfigFunctions.Exists(System.String)">
- <summary>
- Determines whether the given package exists.
- </summary>
- <param name="package">The package to check.</param>
- <returns>
- <see langword="true"/> if the package exists; otherwise,
- <see langword="false"/>.
- </returns>
- <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PkgConfigFunctions.RunPkgConfigBool(NAnt.Core.Types.Argument[])">
- <summary>
- Runs pkg-config with the specified arguments and returns a
- <see cref="T:System.Boolean"/> based on the exit code.
- </summary>
- <param name="args">The arguments to pass to pkg-config.</param>
- <returns>
- <see langword="true"/> if pkg-config exited with exit code 0;
- otherwise, <see langword="false"/>
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.PkgConfigFunctions.RunPkgConfigString(NAnt.Core.Types.Argument[])">
- <summary>
- Runs pkg-config with the specified arguments and returns the result
- as a <see cref="T:System.String"/>.
- </summary>
- <param name="args">The arguments to pass to pkg-config.</param>
- <returns>
- The result of running pkg-config with the specified arguments.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.PkgConfigFunctions.GetTask(System.IO.Stream)">
- <summary>
- Factory method to return a new instance of ExecTask
- </summary>
- <param name="stream"></param>
- <returns></returns>
- </member>
- <member name="M:NAnt.Core.Functions.StringFunctions.GetLength(System.String)">
- <summary>
- Returns the length of the specified string.
- </summary>
- <param name="s">input string</param>
- <returns>
- The string's length.
- </returns>
- <example>
- <code>string::get-length('foo') ==> 3</code>
- </example>
- <example>
- <code>string::get-length('') ==> 0</code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.StringFunctions.Substring(System.String,System.Int32,System.Int32)">
- <summary>
- Returns a substring of the specified string.
- </summary>
- <param name="str">input string</param>
- <param name="startIndex">position of the start of the substring</param>
- <param name="length">the length of the substring</param>
- <returns>
- <para>
- If the <paramref name="length"/> is greater than zero, the
- function returns a substring starting at character position
- <paramref name="startIndex"/> with a length of <paramref name="length"/>
- characters.
- </para>
- <para>
- If the <paramref name="length"/> is equal to zero, the function
- returns an empty string.
- </para>
- </returns>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="startIndex"/> or <paramref name="length"/> is less than zero.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="startIndex"/> is greater than the length of <paramref name="str"/>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="startIndex"/> plus <paramref name="length"/> indicates a position not within <paramref name="str"/>.</exception>
- <example>
- <code>string::substring('testing string', 0, 4) ==> 'test'</code>
- </example>
- <example>
- <code>string::substring('testing string', 8, 3) ==> 'str'</code>
- </example>
- <example>
- <code>string::substring('testing string', 8, 0) ==> ''</code>
- </example>
- <example>
- <code>string::substring('testing string', -1, 5) ==> ERROR</code>
- </example>
- <example>
- <code>string::substring('testing string', 8, -1) ==> ERROR</code>
- </example>
- <example>
- <code>string::substring('testing string', 5, 17) ==> ERROR</code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.StringFunctions.StartsWith(System.String,System.String)">
- <summary>
- Tests whether the specified string starts with the specified prefix
- string.
- </summary>
- <param name="s1">test string</param>
- <param name="s2">prefix string</param>
- <returns>
- <see langword="true" /> when <paramref name="s2" /> is a prefix for
- the string <paramref name="s1" />. Meaning, the characters at the
- beginning of <paramref name="s1" /> are identical to
- <paramref name="s2" />; otherwise, <see langword="false" />.
- </returns>
- <remarks>
- This function performs a case-sensitive word search using the
- invariant culture.
- </remarks>
- <example>
- <code>string::starts-with('testing string', 'test') ==> true</code>
- </example>
- <example>
- <code>string::starts-with('testing string', 'testing') ==> true</code>
- </example>
- <example>
- <code>string::starts-with('testing string', 'string') ==> false</code>
- </example>
- <example>
- <code>string::starts-with('test', 'testing string') ==> false</code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.StringFunctions.EndsWith(System.String,System.String)">
- <summary>
- Tests whether the specified string ends with the specified suffix
- string.
- </summary>
- <param name="s1">test string</param>
- <param name="s2">suffix string</param>
- <returns>
- <see langword="true" /> when <paramref name="s2" /> is a suffix for
- the string <paramref name="s1" />. Meaning, the characters at the
- end of <paramref name="s1" /> are identical to
- <paramref name="s2" />; otherwise, <see langword="false" />.
- </returns>
- <remarks>
- This function performs a case-sensitive word search using the
- invariant culture.
- </remarks>
- <example>
- <code>string::ends-with('testing string', 'string') ==> true</code>
- </example>
- <example>
- <code>string::ends-with('testing string', '') ==> true</code>
- </example>
- <example>
- <code>string::ends-with('testing string', 'bring') ==> false</code>
- </example>
- <example>
- <code>string::ends-with('string', 'testing string') ==> false</code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.StringFunctions.ToLower(System.String)">
- <summary>
- Returns the specified string converted to lowercase.
- </summary>
- <param name="s">input string</param>
- <returns>
- The string <paramref name="s" /> in lowercase.
- </returns>
- <remarks>
- The casing rules of the invariant culture are used to convert the
- <paramref name="s" /> to lowercase.
- </remarks>
- <example>
- <code>string::to-lower('testing string') ==> 'testing string'</code>
- </example>
- <example>
- <code>string::to-lower('Testing String') ==> 'testing string'</code>
- </example>
- <example>
- <code>string::to-lower('Test 123') ==> 'test 123'</code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.StringFunctions.ToUpper(System.String)">
- <summary>
- Returns the specified string converted to uppercase.
- </summary>
- <param name="s">input string</param>
- <returns>
- The string <paramref name="s" /> in uppercase.
- </returns>
- <remarks>
- The casing rules of the invariant culture are used to convert the
- <paramref name="s" /> to uppercase.
- </remarks>
- <example>
- <code>string::to-upper('testing string') ==> 'TESTING STRING'</code>
- </example>
- <example>
- <code>string::to-upper('Testing String') ==> 'TESTING STRING'</code>
- </example>
- <example>
- <code>string::to-upper('Test 123') ==> 'TEST 123'</code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.StringFunctions.Replace(System.String,System.String,System.String)">
- <summary>
- Returns a string corresponding to the replacement of a given string
- with another in the specified string.
- </summary>
- <param name="str">input string</param>
- <param name="oldValue">A <see cref="T:System.String"/> to be replaced.</param>
- <param name="newValue">A <see cref="T:System.String"/> to replace all occurrences of <paramref name="oldValue"/>.</param>
- <returns>
- A <see cref="T:System.String"/> equivalent to <paramref name="str"/> but
- with all instances of <paramref name="oldValue"/> replaced with
- <paramref name="newValue"/>.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="oldValue"/> is an empty string.</exception>
- <remarks>
- This function performs a word (case-sensitive and culture-sensitive)
- search to find <paramref name="oldValue"/>.
- </remarks>
- <example>
- <code>string::replace('testing string', 'test', 'winn') ==> 'winning string'</code>
- </example>
- <example>
- <code>string::replace('testing string', 'foo', 'winn') ==> 'testing string'</code>
- </example>
- <example>
- <code>string::replace('testing string', 'ing', '') ==> 'test str'</code>
- </example>
- <example>
- <code>string::replace('banana', 'ana', 'ana') ==> 'banana'</code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.StringFunctions.Contains(System.String,System.String)">
- <summary>
- Tests whether the specified string contains the given search string.
- </summary>
- <param name="source">The string to search.</param>
- <param name="value">The string to locate within <paramref name="source" />.</param>
- <returns>
- <see langword="true" /> if <paramref name="value" /> is found in
- <paramref name="source" />; otherwise, <see langword="false" />.
- </returns>
- <remarks>
- This function performs a case-sensitive word search using the
- invariant culture.
- </remarks>
- <example>
- <code>string::contains('testing string', 'test') ==> true</code>
- </example>
- <example>
- <code>string::contains('testing string', '') ==> true</code>
- </example>
- <example>
- <code>string::contains('testing string', 'Test') ==> false</code>
- </example>
- <example>
- <code>string::contains('testing string', 'foo') ==> false</code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.StringFunctions.IndexOf(System.String,System.String)">
- <summary>
- Returns the position of the first occurrence in the specified string
- of the given search string.
- </summary>
- <param name="source">The string to search.</param>
- <param name="value">The string to locate within <paramref name="source" />.</param>
- <returns>
- <para>
- The lowest-index position of <paramref name="value" /> in
- <paramref name="source" /> if it is found, or -1 if <paramref name="source" />
- does not contain <paramref name="value" />.
- </para>
- <para>
- If <paramref name="value" /> is an empty string, the return value
- will always be <c>0</c>.
- </para>
- </returns>
- <remarks>
- This function performs a case-sensitive word search using the
- invariant culture.
- </remarks>
- <example>
- <code>string::index-of('testing string', 'test') ==> 0</code>
- </example>
- <example>
- <code>string::index-of('testing string', '') ==> 0</code>
- </example>
- <example>
- <code>string::index-of('testing string', 'Test') ==> -1</code>
- </example>
- <example>
- <code>string::index-of('testing string', 'ing') ==> 4</code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.StringFunctions.LastIndexOf(System.String,System.String)">
- <summary>
- Returns the position of the last occurrence in the specified string
- of the given search string.
- </summary>
- <param name="source">The string to search.</param>
- <param name="value">The string to locate within <paramref name="source" />.</param>
- <returns>
- <para>
- The highest-index position of <paramref name="value" /> in
- <paramref name="source" /> if it is found, or -1 if <paramref name="source" />
- does not contain <paramref name="value" />.
- </para>
- <para>
- If <paramref name="value" /> is an empty string, the return value
- is the last index position in <paramref name="source" />.
- </para>
- </returns>
- <remarks>
- This function performs a case-sensitive word search using the
- invariant culture.
- </remarks>
- <example>
- <code>string::last-index-of('testing string', 'test') ==> 0</code>
- </example>
- <example>
- <code>string::last-index-of('testing string', '') ==> 13</code>
- </example>
- <example>
- <code>string::last-index-of('testing string', 'Test') ==> -1</code>
- </example>
- <example>
- <code>string::last-index-of('testing string', 'ing') ==> 11</code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.StringFunctions.PadLeft(System.String,System.Int32,System.String)">
- <summary>
- Returns the given string left-padded to the given length.
- </summary>
- <param name="s">The <see cref="T:System.String"/> that needs to be left-padded.</param>
- <param name="totalWidth">The number of characters in the resulting string, equal to the number of original characters plus any additional padding characters.</param>
- <param name="paddingChar">A Unicode padding character.</param>
- <returns>
- If the length of <paramref name="s"/> is at least
- <paramref name="totalWidth"/>, then a new <see cref="T:System.String"/> identical
- to <paramref name="s"/> is returned. Otherwise, <paramref name="s"/>
- will be padded on the left with as many <paramref name="paddingChar"/>
- characters as needed to create a length of <paramref name="totalWidth"/>.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="totalWidth"/> is less than zero.</exception>
- <remarks>
- Note that only the first character of <paramref name="paddingChar"/>
- will be used when padding the result.
- </remarks>
- <example>
- <code>string::pad-left('test', 10, ' ') ==> ' test'</code>
- </example>
- <example>
- <code>string::pad-left('test', 10, 'test') ==> 'tttttttest'</code>
- </example>
- <example>
- <code>string::pad-left('test', 3, ' ') ==> 'test'</code>
- </example>
- <example>
- <code>string::pad-left('test', -4, ' ') ==> ERROR</code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.StringFunctions.PadRight(System.String,System.Int32,System.String)">
- <summary>
- Returns the given string right-padded to the given length.
- </summary>
- <param name="s">The <see cref="T:System.String"/> that needs to be right-padded.</param>
- <param name="totalWidth">The number of characters in the resulting string, equal to the number of original characters plus any additional padding characters.</param>
- <param name="paddingChar">A Unicode padding character.</param>
- <returns>
- If the length of <paramref name="s"/> is at least
- <paramref name="totalWidth"/>, then a new <see cref="T:System.String"/> identical
- to <paramref name="s"/> is returned. Otherwise, <paramref name="s"/>
- will be padded on the right with as many <paramref name="paddingChar"/>
- characters as needed to create a length of <paramref name="totalWidth"/>.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="totalWidth"/> is less than zero.</exception>
- <remarks>
- Note that only the first character of <paramref name="paddingChar"/>
- will be used when padding the result.
- </remarks>
- <example>
- <code>string::pad-right('test', 10, ' ') ==> 'test '</code>
- </example>
- <example>
- <code>string::pad-right('test', 10, 'abcd') ==> 'testaaaaaa'</code>
- </example>
- <example>
- <code>string::pad-right('test', 3, ' ') ==> 'test'</code>
- </example>
- <example>
- <code>string::pad-right('test', -3, ' ') ==> ERROR</code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.StringFunctions.Trim(System.String)">
- <summary>
- Returns the given string trimmed of whitespace.
- </summary>
- <param name="s">input string</param>
- <returns>
- The string <paramref name="s" /> with any leading or trailing
- white space characters removed.
- </returns>
- <example>
- <code>string::trim(' test ') ==> 'test'</code>
- </example>
- <example>
- <code>string::trim('\t\tfoo \r\n') ==> 'foo'</code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.StringFunctions.TrimStart(System.String)">
- <summary>
- Returns the given string trimmed of leading whitespace.
- </summary>
- <param name="s">input string</param>
- <returns>
- The string <paramref name="s" /> with any leading
- whites pace characters removed.
- </returns>
- <example>
- <code>string::trim-start(' test ') ==> 'test '</code>
- </example>
- <example>
- <code>string::trim-start('\t\tfoo \r\n') ==> 'foo \r\n'</code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.StringFunctions.TrimEnd(System.String)">
- <summary>
- Returns the given string trimmed of trailing whitespace.
- </summary>
- <param name="s">input string</param>
- <returns>
- The string <paramref name="s" /> with any trailing
- white space characters removed.
- </returns>
- <example>
- <code>string::trim-end(' test ') ==> ' test'</code>
- </example>
- <example>
- <code>string::trim-end('\t\tfoo \r\n') ==> '\t\tfoo'</code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTotalDays(System.TimeSpan)">
- <summary>
- Returns the total number of days represented by the specified
- <see cref="T:System.TimeSpan"/>, expressed in whole and fractional days.
- </summary>
- <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
- <returns>
- The total number of days represented by the given <see cref="T:System.TimeSpan"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTotalHours(System.TimeSpan)">
- <summary>
- Returns the total number of hours represented by the specified
- <see cref="T:System.TimeSpan"/>, expressed in whole and fractional hours.
- </summary>
- <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
- <returns>
- The total number of hours represented by the given <see cref="T:System.TimeSpan"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTotalMinutes(System.TimeSpan)">
- <summary>
- Returns the total number of minutes represented by the specified
- <see cref="T:System.TimeSpan"/>, expressed in whole and fractional minutes.
- </summary>
- <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
- <returns>
- The total number of minutes represented by the given <see cref="T:System.TimeSpan"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTotalSeconds(System.TimeSpan)">
- <summary>
- Returns the total number of seconds represented by the specified
- <see cref="T:System.TimeSpan"/>, expressed in whole and fractional seconds.
- </summary>
- <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
- <returns>
- The total number of seconds represented by the given <see cref="T:System.TimeSpan"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTotalMilliseconds(System.TimeSpan)">
- <summary>
- Returns the total number of milliseconds represented by the specified
- <see cref="T:System.TimeSpan"/>, expressed in whole and fractional milliseconds.
- </summary>
- <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
- <returns>
- The total number of milliseconds represented by the given
- <see cref="T:System.TimeSpan"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetDays(System.TimeSpan)">
- <summary>
- Returns the number of whole days represented by the specified
- <see cref="T:System.TimeSpan"/>.
- </summary>
- <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
- <returns>
- The number of whole days represented by the given
- <see cref="T:System.TimeSpan"/>.
- </returns>
- <example>
- <para>
- Remove all files that have not been modified in the last 7 days from directory "binaries".</para>
- <code>
- <![CDATA[
- <foreach item="File" in="binaries" property="filename">
- <if test="${timespan::get-days(datetime::now() - file::get-last-write-time(filename)) >= 7}">
- <delete file="${filename}" />
- </if>
- </foreach>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetHours(System.TimeSpan)">
- <summary>
- Returns the number of whole hours represented by the specified
- <see cref="T:System.TimeSpan"/>.
- </summary>
- <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
- <returns>
- The number of whole hours represented by the given
- <see cref="T:System.TimeSpan"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetMinutes(System.TimeSpan)">
- <summary>
- Returns the number of whole minutes represented by the specified
- <see cref="T:System.TimeSpan"/>.
- </summary>
- <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
- <returns>
- The number of whole minutes represented by the given
- <see cref="T:System.TimeSpan"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetSeconds(System.TimeSpan)">
- <summary>
- Returns the number of whole seconds represented by the specified
- <see cref="T:System.TimeSpan"/>.
- </summary>
- <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
- <returns>
- The number of whole seconds represented by the given
- <see cref="T:System.TimeSpan"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetMilliseconds(System.TimeSpan)">
- <summary>
- Returns the number of whole milliseconds represented by the specified
- <see cref="T:System.TimeSpan"/>.
- </summary>
- <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
- <returns>
- The number of whole milliseconds represented by the given
- <see cref="T:System.TimeSpan"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTicks(System.TimeSpan)">
- <summary>
- Returns the number of ticks contained in the specified
- <see cref="T:System.TimeSpan"/>.
- </summary>
- <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
- <returns>
- The number of ticks contained in the given <see cref="T:System.TimeSpan"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromDays(System.Double)">
- <summary>
- Returns a <see cref="T:System.TimeSpan"/> that represents a specified number
- of days, where the specification is accurate to the nearest millisecond.
- </summary>
- <param name="value">A number of days, accurate to the nearest millisecond.</param>
- <returns>
- A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromHours(System.Double)">
- <summary>
- Returns a <see cref="T:System.TimeSpan"/> that represents a specified number
- of hours, where the specification is accurate to the nearest
- millisecond.
- </summary>
- <param name="value">A number of hours, accurate to the nearest millisecond.</param>
- <returns>
- A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromMinutes(System.Double)">
- <summary>
- Returns a <see cref="T:System.TimeSpan"/> that represents a specified number
- of minutes, where the specification is accurate to the nearest
- millisecond.
- </summary>
- <param name="value">A number of minutes, accurate to the nearest millisecond.</param>
- <returns>
- A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromSeconds(System.Double)">
- <summary>
- Returns a <see cref="T:System.TimeSpan"/> that represents a specified number
- of seconds, where the specification is accurate to the nearest
- millisecond.
- </summary>
- <param name="value">A number of seconds, accurate to the nearest millisecond.</param>
- <returns>
- A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromMilliseconds(System.Double)">
- <summary>
- Returns a <see cref="T:System.TimeSpan"/> that represents a specified number
- of milliseconds.
- </summary>
- <param name="value">A number of milliseconds.</param>
- <returns>
- A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromTicks(System.Int64)">
- <summary>
- Returns a <see cref="T:System.TimeSpan"/> that represents a specified time,
- where the specification is in units of ticks.
- </summary>
- <param name="value">A number of ticks that represent a time.</param>
- <returns>
- A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanConversionFunctions.Parse(System.String)">
- <summary>
- Constructs a <see cref="T:System.TimeSpan"/> from a time indicated by a
- specified string.
- </summary>
- <param name="s">A string.</param>
- <returns>
- A <see cref="T:System.TimeSpan"/> that corresponds to <paramref name="s"/>.
- </returns>
- <exception cref="T:System.FormatException"><paramref name="s"/> has an invalid format.</exception>
- <exception cref="T:System.OverflowException">At least one of the hours, minutes, or seconds components is outside its valid range.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanConversionFunctions.ToString(System.TimeSpan)">
- <summary>
- Converts the specified <see cref="T:System.TimeSpan"/> to its equivalent
- string representation.
- </summary>
- <param name="value">A <see cref="T:System.TimeSpan"/> to convert.</param>
- <returns>
- The string representation of <paramref name="value"/>. The format
- of the return value is of the form: [-][d.]hh:mm:ss[.ff].
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.VersionFunctions.GetMajor(System.Version)">
- <summary>
- Gets the value of the major component of a given version.
- </summary>
- <param name="version">A version.</param>
- <returns>
- The major version number.
- </returns>
- <seealso cref="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)"/>
- <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/>
- <seealso cref="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)"/>
- </member>
- <member name="M:NAnt.Core.Functions.VersionFunctions.GetMinor(System.Version)">
- <summary>
- Gets the value of the minor component of a given version.
- </summary>
- <param name="version">A version.</param>
- <returns>
- The minor version number.
- </returns>
- <seealso cref="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)"/>
- <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/>
- <seealso cref="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)"/>
- </member>
- <member name="M:NAnt.Core.Functions.VersionFunctions.GetBuild(System.Version)">
- <summary>
- Gets the value of the build component of a given version.
- </summary>
- <param name="version">A version.</param>
- <returns>
- The build number, or -1 if the build number is undefined.
- </returns>
- <seealso cref="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)"/>
- <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/>
- <seealso cref="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)"/>
- </member>
- <member name="M:NAnt.Core.Functions.VersionFunctions.GetRevision(System.Version)">
- <summary>
- Gets the value of the revision component of a given version.
- </summary>
- <param name="version">A version.</param>
- <returns>
- The revision number, or -1 if the revision number is undefined.
- </returns>
- <seealso cref="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)"/>
- <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/>
- <seealso cref="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)"/>
- </member>
- <member name="M:NAnt.Core.Functions.VersionConversionFunctions.Parse(System.String)">
- <summary>
- Converts the specified string representation of a version to
- its <see cref="T:System.Version"/> equivalent.
- </summary>
- <param name="version">A string containing the major, minor, build, and revision numbers, where each number is delimited with a period character ('.').</param>
- <returns>
- A <see cref="T:System.Version"/> instance representing the specified
- <see cref="T:System.String"/>.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="version"/> has fewer than two components or more than four components.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">A major, minor, build, or revision component is less than zero.</exception>
- <exception cref="T:System.FormatException">At least one component of <paramref name="version"/> does not parse to a decimal integer.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.VersionConversionFunctions.ToString(System.Version)">
- <summary>
- Converts the specified <see cref="T:System.Version"/> to its equivalent
- string representation.
- </summary>
- <param name="value">A <see cref="T:System.Version"/> to convert.</param>
- <returns>
- The string representation of the values of the major, minor, build,
- and revision components of the specified <see cref="T:System.Version"/>.
- </returns>
- <seealso cref="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)"/>
- <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/>
- <seealso cref="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)"/>
- </member>
- <member name="T:NAnt.Core.Tasks.AttribTask">
- <summary>
- Changes the file attributes of a file or set of files and directories.
- </summary>
- <remarks>
- <para>
- <see cref="T:NAnt.Core.Tasks.AttribTask"/> does not have the concept of turning
- attributes off. Instead you specify all the attributes that you want
- turned on and the rest are turned off by default.
- </para>
- <para>
- Refer to the <see cref="T:System.IO.FileAttributes"/> enumeration in the .NET SDK
- for more information about file attributes.
- </para>
- </remarks>
- <example>
- <para>
- Set the <c>read-only</c> file attribute for the specified file in
- the project directory.
- </para>
- <code>
- <![CDATA[
- <attrib file="myfile.txt" readonly="true" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Set the <c>normal</c> file attribute for the specified file.
- </para>
- <code>
- <![CDATA[
- <attrib file="myfile.txt" normal="true" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Set the <c>normal</c> file attribute for all executable files in
- the current project directory and sub-directories.
- </para>
- <code>
- <![CDATA[
- <attrib normal="true">
- <fileset>
- <include name="**/*.exe" />
- <include name="bin" />
- </fileset>
- </attrib>
- ]]>
- </code>
- </example>
- </member>
- <member name="T:NAnt.Core.Task">
- <summary>
- Provides the abstract base class for tasks.
- </summary>
- <remarks>
- A task is a piece of code that can be executed.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Task.Execute">
- <summary>
- Executes the task unless it is skipped.
- </summary>
- </member>
- <member name="M:NAnt.Core.Task.Log(NAnt.Core.Level,System.String)">
- <summary>
- Logs a message with the given priority.
- </summary>
- <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
- <param name="message">The message to be logged.</param>
- <remarks>
- <para>
- The actual logging is delegated to the project.
- </para>
- <para>
- If the <see cref="P:NAnt.Core.Task.Verbose"/> attribute is set on the task and a
- message is logged with level <see cref="F:NAnt.Core.Level.Verbose"/>, the
- priority of the message will be increased to <see cref="F:NAnt.Core.Level.Info"/>
- when the threshold of the build log is <see cref="F:NAnt.Core.Level.Info"/>.
- </para>
- <para>
- This will allow individual tasks to run in verbose mode while
- the build log itself is still configured with threshold
- <see cref="F:NAnt.Core.Level.Info"/>.
- </para>
- <para>
- The threshold of the project is not taken into account to determine
- whether a message should be passed to the logging infrastructure,
- as build listeners might be interested in receiving all messages.
- </para>
- </remarks>
- </member>
- <member name="M:NAnt.Core.Task.Log(NAnt.Core.Level,System.String,System.Object[])">
- <summary>
- Logs a formatted message with the given priority.
- </summary>
- <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
- <param name="message">The message to log, containing zero or more format items.</param>
- <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
- <remarks>
- <para>
- The actual logging is delegated to the project.
- </para>
- <para>
- If the <see cref="P:NAnt.Core.Task.Verbose"/> attribute is set on the task and a
- message is logged with level <see cref="F:NAnt.Core.Level.Verbose"/>, the
- priority of the message will be increased to <see cref="F:NAnt.Core.Level.Info"/>.
- when the threshold of the build log is <see cref="F:NAnt.Core.Level.Info"/>.
- </para>
- <para>
- This will allow individual tasks to run in verbose mode while
- the build log itself is still configured with threshold
- <see cref="F:NAnt.Core.Level.Info"/>.
- </para>
- </remarks>
- </member>
- <member name="M:NAnt.Core.Task.IsLogEnabledFor(NAnt.Core.Level)">
- <summary>
- Determines whether build output is enabled for the given
- <see cref="T:NAnt.Core.Level"/>.
- </summary>
- <param name="messageLevel">The <see cref="T:NAnt.Core.Level"/> to check.</param>
- <returns>
- <see langword="true"/> if messages with the given <see cref="T:NAnt.Core.Level"/>
- should be passed on to the logging infrastructure; otherwise,
- <see langword="false"/>.
- </returns>
- <remarks>
- The threshold of the project is not taken into account to determine
- whether a message should be passed to the logging infrastructure,
- as build listeners might be interested in receiving all messages.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Task.InitializeTaskConfiguration">
- <summary>
- Initializes the configuration of the task using configuration
- settings retrieved from the NAnt configuration file.
- </summary>
- <remarks>
- TO-DO : Remove this temporary hack when a permanent solution is
- available for loading the default values from the configuration
- file if a build element is constructed from code.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Task.InitializeElement(System.Xml.XmlNode)">
- <summary><note>Deprecated (to be deleted).</note></summary>
- </member>
- <member name="M:NAnt.Core.Task.InitializeTask(System.Xml.XmlNode)">
- <summary>Initializes the task.</summary>
- </member>
- <member name="M:NAnt.Core.Task.ExecuteTask">
- <summary>Executes the task.</summary>
- </member>
- <member name="P:NAnt.Core.Task.FailOnError">
- <summary>
- Determines if task failure stops the build, or is just reported.
- The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Task.Verbose">
- <summary>
- Determines whether the task should report detailed build log messages.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Task.IfDefined">
- <summary>
- If <see langword="true" /> then the task will be executed; otherwise,
- skipped. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Task.UnlessDefined">
- <summary>
- Opposite of <see cref="P:NAnt.Core.Task.IfDefined"/>. If <see langword="false"/>
- then the task will be executed; otherwise, skipped. The default is
- <see langword="false"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Task.Name">
- <summary>
- The name of the task.
- </summary>
- </member>
- <member name="P:NAnt.Core.Task.LogPrefix">
- <summary>
- The prefix used when sending messages to the log.
- </summary>
- </member>
- <member name="P:NAnt.Core.Task.Threshold">
- <summary>
- Gets or sets the log threshold for this <see cref="T:NAnt.Core.Task"/>. By
- default the threshold of a task is <see cref="F:NAnt.Core.Level.Debug"/>,
- causing no messages to be filtered in the task itself.
- </summary>
- <value>
- The log threshold level for this <see cref="T:NAnt.Core.Task"/>.
- </value>
- <remarks>
- When the threshold of a <see cref="T:NAnt.Core.Task"/> is higher than the
- threshold of the <see cref="T:NAnt.Core.Project"/>, then all messages will
- still be delivered to the build listeners.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Tasks.AttribTask.File">
- <summary>
- The name of the file which will have its attributes set. This is
- provided as an alternate to using the task's fileset.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.AttribTask.AttribFileSet">
- <summary>
- All the matching files and directories in this fileset will have
- their attributes set.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.AttribTask.ArchiveAttrib">
- <summary>
- Set the archive attribute. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.AttribTask.HiddenAttrib">
- <summary>
- Set the hidden attribute. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.AttribTask.NormalAttrib">
- <summary>
- Set the normal file attributes. This attribute is only valid if used
- alone. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.AttribTask.ReadOnlyAttrib">
- <summary>
- Set the read-only attribute. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.AttribTask.SystemAttrib">
- <summary>
- Set the system attribute. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.AvailableTask">
- <summary>
- Checks if a resource is available at runtime.
- </summary>
- <remarks>
- <para>
- The specified property is set to <see langword="true"/> if the
- requested resource is available at runtime, and <see langword="false"/>
- if the resource is not available.
- </para>
- <note>
- we advise you to use the following functions instead:
- </note>
- <list type="table">
- <listheader>
- <term>Function</term>
- <description>Description</description>
- </listheader>
- <item>
- <term><see cref="M:NAnt.Core.Functions.FileFunctions.Exists(System.String)"/></term>
- <description>Determines whether the specified file exists.</description>
- </item>
- <item>
- <term><see cref="M:NAnt.Core.Functions.DirectoryFunctions.Exists(System.String)"/></term>
- <description>Determines whether the given path refers to an existing directory on disk.</description>
- </item>
- <item>
- <term><see cref="M:NAnt.Core.Functions.FrameworkFunctions.Exists(System.String)"/></term>
- <description>Checks whether the specified framework exists..</description>
- </item>
- <item>
- <term><see cref="M:NAnt.Core.Functions.FrameworkFunctions.SdkExists(System.String)"/></term>
- <description>Checks whether the SDK for the specified framework is installed.</description>
- </item>
- </list>
- </remarks>
- <example>
- <para>
- Sets the <c>myfile.present</c> property to <see langword="true"/> if the
- file is available on the filesystem and <see langword="false"/> if the
- file is not available.
- </para>
- <code>
- <![CDATA[
- <available type="File" resource="myfile.txt" property="myfile.present" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Sets the <c>build.dir.present</c> property to <see langword="true"/>
- if the directory is available on the filesystem and <see langword="false"/>
- if the directory is not available.
- </para>
- <code>
- <![CDATA[
- <available type="Directory" resource="build" property="build.dir.present" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Sets the <c>mono-0.21.framework.present</c> property to <see langword="true"/>
- if the Mono 0.21 framework is available on the current system and
- <see langword="false"/> if the framework is not available.
- </para>
- <code>
- <![CDATA[
- <available type="Framework" resource="mono-0.21" property="mono-0.21.framework.present" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Sets the <c>net-1.1.frameworksdk.present</c> property to <see langword="true"/>
- if the .NET 1.1 Framework SDK is available on the current system and
- <see langword="false"/> if the SDK is not available.
- </para>
- <code>
- <![CDATA[
- <available type="FrameworkSDK" resource="net-1.1" property="net-1.1.frameworksdk.present" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Tasks.AvailableTask.ExecuteTask">
- <summary>
- Executes the task.
- </summary>
- <remarks>
- <para>
- Sets the property identified by <see cref="P:NAnt.Core.Tasks.AvailableTask.PropertyName"/> to
- <see langword="true"/> when the resource exists and to <see langword="false"/>
- when the resource doesn't exist.
- </para>
- </remarks>
- <exception cref="T:NAnt.Core.BuildException">The availability of the resource could not be evaluated.</exception>
- </member>
- <member name="M:NAnt.Core.Tasks.AvailableTask.Evaluate">
- <summary>
- Evaluates the availability of a resource.
- </summary>
- <returns>
- <see langword="true"/> if the resource is available; otherwise,
- <see langword="false"/>.
- </returns>
- <exception cref="T:NAnt.Core.BuildException">The availability of the resource could not be evaluated.</exception>
- </member>
- <member name="M:NAnt.Core.Tasks.AvailableTask.CheckFile">
- <summary>
- Checks if the file specified in the <see cref="P:NAnt.Core.Tasks.AvailableTask.Resource"/> property is
- available on the filesystem.
- </summary>
- <returns>
- <see langword="true"/> when the file exists; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Tasks.AvailableTask.CheckDirectory">
- <summary>
- Checks if the directory specified in the <see cref="P:NAnt.Core.Tasks.AvailableTask.Resource"/>
- property is available on the filesystem.
- </summary>
- <returns>
- <see langword="true"/> when the directory exists; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Tasks.AvailableTask.CheckFramework">
- <summary>
- Checks if the framework specified in the <see cref="P:NAnt.Core.Tasks.AvailableTask.Resource"/>
- property is available on the current system.
- </summary>
- <returns>
- <see langword="true"/> when the framework is available; otherwise,
- <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Tasks.AvailableTask.CheckFrameworkSDK">
- <summary>
- Checks if the SDK for the framework specified in the <see cref="P:NAnt.Core.Tasks.AvailableTask.Resource"/>
- property is available on the current system.
- </summary>
- <returns>
- <see langword="true"/> when the SDK for the specified framework is
- available; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="P:NAnt.Core.Tasks.AvailableTask.Resource">
- <summary>
- The resource which must be available.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.AvailableTask.Type">
- <summary>
- The type of resource which must be present.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.AvailableTask.PropertyName">
- <summary>
- The property that must be set if the resource is available.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.AvailableTask.ResourceType">
- <summary>
- Defines the possible resource checks.
- </summary>
- </member>
- <member name="F:NAnt.Core.Tasks.AvailableTask.ResourceType.File">
- <summary>
- Determines whether a given file exists.
- </summary>
- </member>
- <member name="F:NAnt.Core.Tasks.AvailableTask.ResourceType.Directory">
- <summary>
- Determines whether a given directory exists.
- </summary>
- </member>
- <member name="F:NAnt.Core.Tasks.AvailableTask.ResourceType.Framework">
- <summary>
- Determines whether a given framework is available.
- </summary>
- </member>
- <member name="F:NAnt.Core.Tasks.AvailableTask.ResourceType.FrameworkSDK">
- <summary>
- Determines whether a given SDK is available.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.CallTask">
- <summary>
- Calls a NAnt target in the current project.
- </summary>
- <remarks>
- <para>
- When the <see cref="T:NAnt.Core.Tasks.CallTask"/> is used to execute a target, both that
- target and all its dependent targets will be re-executed.
- </para>
- <para>
- To avoid dependent targets from being executed more than once, two
- options are available:
- </para>
- <list type="bullet">
- <item>
- <description>
- Add an "unless" attribute with value "${<see href="../functions/target.has-executed.html">target::has-executed</see>('<c><target name></c>')}"
- to the dependent targets.
- </description>
- </item>
- <item>
- <description>
- Set the <see cref="P:NAnt.Core.Tasks.CallTask.CascadeDependencies"/> attribute on the
- <see cref="T:NAnt.Core.Tasks.CallTask"/> to <see langword="false "/> (<c>recommended</c>).
- </description>
- </item>
- </list>
- </remarks>
- <example>
- <para>
- Call the target "build".
- </para>
- <code>
- <![CDATA[
- <call target="build" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- This shows how a project could 'compile' a debug and release build
- using a common compile target.
- </para>
- <code>
- <![CDATA[
- <project default="build">
- <property name="debug" value="false" />
- <target name="init">
- <echo message="initializing" />
- </target>
- <target name="compile" depends="init">
- <echo message="compiling with debug = ${debug}" />
- </target>
- <target name="build">
- <property name="debug" value="false" />
- <call target="compile" />
- <property name="debug" value="true" />
- <call target="compile" />
- </target>
- </project>
- ]]>
- </code>
- <para>
- The <see cref="P:NAnt.Core.Tasks.CallTask.CascadeDependencies"/> parameter of the
- <see cref="T:NAnt.Core.Tasks.CallTask"/> defaults to <see langword="true"/>,
- causing the "init" target to be executed for both
- the "debug" and "release" build.
- </para>
- <para>
- This results in the following build log:
- </para>
- <code>
- build:
-
- init:
-
- [echo] initializing
-
- compile:
-
- [echo] compiling with debug = false
-
- init:
-
- [echo] initializing
-
- compile:
-
- [echo] compiling with debug = true
-
- BUILD SUCCEEDED
- </code>
- <para>
- If the "init" should only be executed once, set the
- <see cref="P:NAnt.Core.Tasks.CallTask.CascadeDependencies"/> attribute of the <see cref="T:NAnt.Core.Tasks.CallTask"/>
- to <see langword="false"/>.
- </para>
- <para>
- The build log would then look like this:
- </para>
- <code>
- build:
-
- init:
-
- [echo] initializing
-
- compile:
-
- [echo] compiling with debug = false
-
- compile:
-
- [echo] compiling with debug = true
-
- BUILD SUCCEEDED
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Tasks.CallTask.ExecuteTask">
- <summary>
- Executes the specified target.
- </summary>
- </member>
- <member name="M:NAnt.Core.Tasks.CallTask.InitializeTask(System.Xml.XmlNode)">
- <summary>
- Makes sure the <see cref="T:NAnt.Core.Tasks.CallTask"/> is not calling its own
- parent.
- </summary>
- <param name="taskNode">The task XML node.</param>
- </member>
- <member name="P:NAnt.Core.Tasks.CallTask.TargetName">
- <summary>
- NAnt target to call.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.CallTask.ForceExecute">
- <summary>
- Force an execute even if the target has already been executed. The
- default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.CallTask.CascadeDependencies">
- <summary>
- Execute the specified targets dependencies -- even if they have been
- previously executed. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.CopyTask">
- <summary>
- Copies a file or set of files to a new file or directory.
- </summary>
- <remarks>
- <para>
- Files are only copied if the source file is newer than the destination
- file, or if the destination file does not exist. However, you can
- explicitly overwrite files with the <see cref="P:NAnt.Core.Tasks.CopyTask.Overwrite"/> attribute.
- </para>
- <para>
- When a <see cref="T:NAnt.Core.Types.FileSet"/> is used to select files to copy, the
- <see cref="P:NAnt.Core.Tasks.CopyTask.ToDirectory"/> attribute must be set. Files that are
- located under the base directory of the <see cref="T:NAnt.Core.Types.FileSet"/> will
- be copied to a directory under the destination directory matching the
- path relative to the base directory of the <see cref="T:NAnt.Core.Types.FileSet"/>,
- unless the <see cref="P:NAnt.Core.Tasks.CopyTask.Flatten"/> attribute is set to
- <see langword="true"/>.
- </para>
- <para>
- Files that are not located under the the base directory of the
- <see cref="T:NAnt.Core.Types.FileSet"/> will be copied directly under to the destination
- directory, regardless of the value of the <see cref="P:NAnt.Core.Tasks.CopyTask.Flatten"/>
- attribute.
- </para>
- <h4>Encoding</h4>
- <para>
- Unless an encoding is specified, the encoding associated with the
- system's current ANSI code page is used.
- </para>
- <para>
- An UTF-8, little-endian Unicode, and big-endian Unicode encoded text
- file is automatically recognized, if the file starts with the
- appropriate byte order marks.
- </para>
- <note>
- If you employ filters in your copy operation, you should limit the copy
- to text files. Binary files will be corrupted by the copy operation.
- </note>
- </remarks>
- <example>
- <para>
- Copy a single file while changing its encoding from "latin1" to
- "utf-8".
- </para>
- <code>
- <![CDATA[
- <copy
- file="myfile.txt"
- tofile="mycopy.txt"
- inputencoding="latin1"
- outputencoding="utf-8" />
- ]]>
- </code>
- </example>
- <example>
- <para>Copy a set of files to a new directory.</para>
- <code>
- <![CDATA[
- <copy todir="${build.dir}">
- <fileset basedir="bin">
- <include name="*.dll" />
- </fileset>
- </copy>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Copy a set of files to a directory, replacing <c>@TITLE@</c> with
- "Foo Bar" in all files.
- </para>
- <code>
- <![CDATA[
- <copy todir="../backup/dir">
- <fileset basedir="src_dir">
- <include name="**/*" />
- </fileset>
- <filterchain>
- <replacetokens>
- <token key="TITLE" value="Foo Bar" />
- </replacetokens>
- </filterchain>
- </copy>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Tasks.CopyTask.#ctor">
- <summary>
- Initialize new instance of the <see cref="T:NAnt.Core.Tasks.CopyTask"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Tasks.CopyTask.InitializeTask(System.Xml.XmlNode)">
- <summary>
- Checks whether the task is initialized with valid attributes.
- </summary>
- <param name="taskNode">The <see cref="T:System.Xml.XmlNode"/> used to initialize the task.</param>
- </member>
- <member name="M:NAnt.Core.Tasks.CopyTask.ExecuteTask">
- <summary>
- Executes the Copy task.
- </summary>
- <exception cref="T:NAnt.Core.BuildException">A file that has to be copied does not exist or could not be copied.</exception>
- </member>
- <member name="M:NAnt.Core.Tasks.CopyTask.DoFileOperations">
- <summary>
- Actually does the file copies.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.CopyTask.SourceFile">
- <summary>
- The file to copy.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.CopyTask.ToFile">
- <summary>
- The file to copy to.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.CopyTask.ToDirectory">
- <summary>
- The directory to copy to.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.CopyTask.Overwrite">
- <summary>
- Overwrite existing files even if the destination files are newer.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.CopyTask.Flatten">
- <summary>
- Ignore directory structure of source directory, copy all files into
- a single directory, specified by the <see cref="P:NAnt.Core.Tasks.CopyTask.ToDirectory"/>
- attribute. The default is <see langword="false"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.CopyTask.IncludeEmptyDirs">
- <summary>
- Copy any empty directories included in the <see cref="T:NAnt.Core.Types.FileSet"/>.
- The default is <see langword="true"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.CopyTask.CopyFileSet">
- <summary>
- Used to select the files to copy. To use a <see cref="T:NAnt.Core.Types.FileSet"/>,
- the <see cref="P:NAnt.Core.Tasks.CopyTask.ToDirectory"/> attribute must be set.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.CopyTask.Filters">
- <summary>
- Chain of filters used to alter the file's content as it is copied.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.CopyTask.InputEncoding">
- <summary>
- The encoding to use when reading files. The default is the system's
- current ANSI code page.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.CopyTask.OutputEncoding">
- <summary>
- The encoding to use when writing the files. The default is
- the encoding of the input file.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.CopyTask.FileCopyMap">
- <summary>
- The set of files to perform a file operation on.
- </summary>
- <remarks>
- <para>
- The key of the <see cref="T:System.Collections.Hashtable"/> is the absolute path of
- the destination file and the value is a <see cref="T:NAnt.Core.Tasks.CopyTask.FileDateInfo"/>
- holding the path and last write time of the most recently updated
- source file that is selected to be copied or moved to the
- destination file.
- </para>
- <para>
- On Windows, the <see cref="T:System.Collections.Hashtable"/> is case-insensitive.
- </para>
- </remarks>
- </member>
- <member name="T:NAnt.Core.Tasks.CopyTask.FileDateInfo">
- <summary>
- Holds the absolute paths and last write time of a given file.
- </summary>
- </member>
- <member name="M:NAnt.Core.Tasks.CopyTask.FileDateInfo.#ctor(System.String,System.DateTime)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Tasks.CopyTask.FileDateInfo"/>
- class for the specified file and last write time.
- </summary>
- <param name="path">The absolute path of the file.</param>
- <param name="lastWriteTime">The last write time of the file.</param>
- </member>
- <member name="P:NAnt.Core.Tasks.CopyTask.FileDateInfo.Path">
- <summary>
- Gets the absolute path of the current file.
- </summary>
- <value>
- The absolute path of the current file.
- </value>
- </member>
- <member name="P:NAnt.Core.Tasks.CopyTask.FileDateInfo.LastWriteTime">
- <summary>
- Gets the time when the current file was last written to.
- </summary>
- <value>
- The time when the current file was last written to.
- </value>
- </member>
- <member name="T:NAnt.Core.Tasks.DeleteTask">
- <summary>
- Deletes a file, fileset or directory.
- </summary>
- <remarks>
- <para>
- Deletes either a single file, all files in a specified directory and
- its sub-directories, or a set of files specified by one or more filesets.
- </para>
- <para>
- If the <see cref="P:NAnt.Core.Tasks.DeleteTask.File"/> or <see cref="P:NAnt.Core.Tasks.DeleteTask.Directory"/> attribute is
- set then the fileset contents will be ignored. To delete the files
- in the fileset ommit the <see cref="P:NAnt.Core.Tasks.DeleteTask.File"/> and <see cref="P:NAnt.Core.Tasks.DeleteTask.Directory"/>
- attributes in the <c><delete></c> element.
- </para>
- <para>
- If the specified file or directory does not exist, no error is
- reported.
- </para>
- <note>
- Read-only files cannot be deleted. Use the <see cref="T:NAnt.Core.Tasks.AttribTask"/>
- first to remove the read-only attribute.
- </note>
- </remarks>
- <example>
- <para>Delete a single file.</para>
- <code>
- <![CDATA[
- <delete file="myfile.txt" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Delete a directory and the contents within. If the directory does not
- exist, no error is reported.
- </para>
- <code>
- <![CDATA[
- <delete dir="${build.dir}" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Delete a set of files.
- </para>
- <code>
- <![CDATA[
- <delete>
- <fileset>
- <include name="${basename}-??.exe" />
- <include name="${basename}-??.pdb" />
- </fileset>
- </delete>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Tasks.DeleteTask.InitializeTask(System.Xml.XmlNode)">
- <summary>
- Ensures the supplied attributes are valid.
- </summary>
- <param name="taskNode">Xml node used to define this task instance.</param>
- </member>
- <member name="P:NAnt.Core.Tasks.DeleteTask.File">
- <summary>
- The file to delete.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.DeleteTask.Directory">
- <summary>
- The directory to delete.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.DeleteTask.IncludeEmptyDirs">
- <summary>
- Remove any empty directories included in the <see cref="T:NAnt.Core.Types.FileSet"/>.
- The default is <see langword="true"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.DeleteTask.DeleteFileSet">
- <summary>
- All the files in the file set will be deleted.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.DeleteTask.Verbose">
- <summary>
- Controls whether to show the name of each deleted file or directory.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.DescriptionTask">
- <summary>
- An empty task that allows a build file to contain a description.
- </summary>
- <example>
- <para>Set a description.</para>
- <code>
- <![CDATA[
- <description>This is a description.</description>
- ]]>
- </code>
- </example>
- </member>
- <member name="T:NAnt.Core.Tasks.EchoTask">
- <summary>
- Writes a message to the build log or a specified file.
- </summary>
- <remarks>
- <para>
- The message can be specified using the <see cref="P:NAnt.Core.Tasks.EchoTask.Message"/> attribute
- or as inline content.
- </para>
- <para>
- Macros in the message will be expanded.
- </para>
- <para>
- When writing to a file, the <see cref="P:NAnt.Core.Tasks.EchoTask.MessageLevel"/> attribute is
- ignored.
- </para>
- </remarks>
- <example>
- <para>
- Writes a message with level <see cref="F:NAnt.Core.Level.Debug"/> to the build log.
- </para>
- <code>
- <![CDATA[
- <echo message="Hello, World!" level="Debug" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Writes a message with expanded macro to the build log.
- </para>
- <code>
- <![CDATA[
- <echo message="Base build directory = ${nant.project.basedir}" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Functionally equivalent to the previous example.
- </para>
- <code>
- <![CDATA[
- <echo>Base build directory = ${nant.project.basedir}</echo>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Writes the previous message to a file in the project directory,
- overwriting the file if it exists.
- </para>
- <code>
- <![CDATA[
- <echo file="buildmessage.txt">Base build directory = ${nant.project.basedir}</echo>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Tasks.EchoTask.ExecuteTask">
- <summary>
- Outputs the message to the build log or the specified file.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.EchoTask.Message">
- <summary>
- The message to output.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.EchoTask.Contents">
- <summary>
- Gets or sets the inline content that should be output.
- </summary>
- <value>
- The inline content that should be output.
- </value>
- </member>
- <member name="P:NAnt.Core.Tasks.EchoTask.File">
- <summary>
- The file to write the message to.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.EchoTask.Append">
- <summary>
- Determines whether the <see cref="T:NAnt.Core.Tasks.EchoTask"/> should append to the
- file, or overwrite it. By default, the file will be overwritten.
- </summary>
- <value>
- <see langword="true"/> if output should be appended to the file;
- otherwise, <see langword="false"/>. The default is
- <see langword="false"/>.
- </value>
- </member>
- <member name="P:NAnt.Core.Tasks.EchoTask.MessageLevel">
- <summary>
- The logging level with which the message should be output. The default
- is <see cref="F:NAnt.Core.Level.Info"/>.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.ExecTask">
- <summary>
- Executes a system command.
- </summary>
- <example>
- <para>Ping "nant.sourceforge.net".</para>
- <code>
- <![CDATA[
- <exec program="ping">
- <arg value="nant.sourceforge.net" />
- </exec>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Execute a java application using <c>IKVM.NET</c> that requires the
- Apache FOP jars, and a set of custom jars.
- </para>
- <code>
- <![CDATA[
- <path id="fop-classpath">
- <pathelement file="${fop.dist.dir}/build/fop.jar" />
- <pathelement file="${fop.dist.dir}/lib/xercesImpl-2.2.1.jar" />
- <pathelement file="${fop.dist.dir}/lib/avalon-framework-cvs-20020806.jar" />
- <pathelement file="${fop.dist.dir}/lib/batik.jar" />
- </path>
- <exec program="ikvm.exe" useruntimeengine="true">
- <arg value="-cp" />
- <arg>
- <path>
- <pathelement dir="conf" />
- <path refid="fop-classpath" />
- <pathelement file="lib/mylib.jar" />
- <pathelement file="lib/otherlib.zip" />
- </path>
- </arg>
- <arg value="org.me.MyProg" />
- </exec>
- ]]>
- </code>
- <para>
- Assuming the base directory of the build file is "c:\ikvm-test" and
- the value of the "fop.dist.dir" property is "c:\fop", then the value
- of the <c>-cp</c> argument that is passed to<c>ikvm.exe</c> is
- "c:\ikvm-test\conf;c:\fop\build\fop.jar;conf;c:\fop\lib\xercesImpl-2.2.1.jar;c:\fop\lib\avalon-framework-cvs-20020806.jar;c:\fop\lib\batik.jar;c:\ikvm-test\lib\mylib.jar;c:\ikvm-test\lib\otherlib.zip"
- on a DOS-based system.
- </para>
- </example>
- </member>
- <member name="T:NAnt.Core.Tasks.ExternalProgramBase">
- <summary>
- Provides the abstract base class for tasks that execute external applications.
- </summary>
- </member>
- <member name="F:NAnt.Core.Tasks.ExternalProgramBase.UnknownExitCode">
- <summary>
- Defines the exit code that will be returned by <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.ExitCode"/>
- if the process could not be started, or did not exit (in time).
- </summary>
- </member>
- <member name="F:NAnt.Core.Tasks.ExternalProgramBase._lockObject">
- <summary>
- Will be used to ensure thread-safe operations.
- </summary>
- </member>
- <member name="M:NAnt.Core.Tasks.ExternalProgramBase.ExecuteTask">
- <summary>
- Starts the external process and captures its output.
- </summary>
- <exception cref="T:NAnt.Core.BuildException">
- <para>The external process did not finish within the configured timeout.</para>
- <para>-or-</para>
- <para>The exit code of the external process indicates a failure.</para>
- </exception>
- </member>
- <member name="M:NAnt.Core.Tasks.ExternalProgramBase.PrepareProcess(System.Diagnostics.Process)">
- <summary>
- Updates the <see cref="T:System.Diagnostics.ProcessStartInfo"/> of the specified
- <see cref="T:System.Diagnostics.Process"/>.
- </summary>
- <param name="process">The <see cref="T:System.Diagnostics.Process"/> of which the <see cref="T:System.Diagnostics.ProcessStartInfo"/> should be updated.</param>
- </member>
- <member name="M:NAnt.Core.Tasks.ExternalProgramBase.StartProcess">
- <summary>
- Starts the process and handles errors.
- </summary>
- <returns>The <see cref="T:System.Diagnostics.Process"/> that was started.</returns>
- </member>
- <member name="M:NAnt.Core.Tasks.ExternalProgramBase.StreamReaderThread_Output">
- <summary>
Reads from the stream until the external program is ended.
</summary>
- </member>
- <member name="M:NAnt.Core.Tasks.ExternalProgramBase.StreamReaderThread_Error">
- <summary>
Reads from the stream until the external program is ended.
</summary>
- </member>
- <member name="M:NAnt.Core.Tasks.ExternalProgramBase.DetermineFilePath">
- <summary>
- Determines the path of the external program that should be executed.
- </summary>
- <returns>
- A fully qualifies pathname including the program name.
- </returns>
- <exception cref="T:NAnt.Core.BuildException">The task is not available or not configured for the current framework.</exception>
- </member>
- <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ExeName">
- <summary>
- The name of the executable that should be used to launch the
- external program.
- </summary>
- <value>
- The name of the executable that should be used to launch the external
- program, or <see langword="null" /> if no name is specified.
- </value>
- <remarks>
- If available, the configured value in the NAnt configuration
- file will be used if no name is specified.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ProgramFileName">
- <summary>
- Gets the filename of the external program to start.
- </summary>
- <value>
- The filename of the external program.
- </value>
- <remarks>
- Override in derived classes to explicitly set the location of the
- external tool.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ProgramArguments">
- <summary>
- Gets the command-line arguments for the external program.
- </summary>
- <value>
- The command-line arguments for the external program.
- </value>
- </member>
- <member name="P:NAnt.Core.Tasks.ExternalProgramBase.Output">
- <summary>
- Gets the file to which the standard output should be redirected.
- </summary>
- <value>
- The file to which the standard output should be redirected, or
- <see langword="null" /> if the standard output should not be
- redirected.
- </value>
- <remarks>
- The default implementation will never allow the standard output
- to be redirected to a file. Deriving classes should override this
- property to change this behaviour.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Tasks.ExternalProgramBase.OutputAppend">
- <summary>
- Gets a value indicating whether output will be appended to the
- <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Output"/>.
- </summary>
- <value>
- <see langword="true"/> if output should be appended to the <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Output"/>;
- otherwise, <see langword="false"/>.
- </value>
- </member>
- <member name="P:NAnt.Core.Tasks.ExternalProgramBase.BaseDirectory">
- <summary>
- Gets the working directory for the application.
- </summary>
- <value>
- The working directory for the application.
- </value>
- </member>
- <member name="P:NAnt.Core.Tasks.ExternalProgramBase.TimeOut">
- <summary>
- The maximum amount of time the application is allowed to execute,
- expressed in milliseconds. Defaults to no time-out.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.ExternalProgramBase.Arguments">
- <summary>
- The command-line arguments for the external program.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.ExternalProgramBase.UseRuntimeEngine">
- <summary>
- Specifies whether the external program should be executed using a
- runtime engine, if configured. The default is <see langword="false" />.
- </summary>
- <value>
- <see langword="true" /> if the external program should be executed
- using a runtime engine; otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.Tasks.ExternalProgramBase.OutputWriter">
- <summary>
- Gets or sets the <see cref="T:System.IO.TextWriter"/> to which standard output
- messages of the external program will be written.
- </summary>
- <value>
- The <see cref="T:System.IO.TextWriter"/> to which standard output messages of
- the external program will be written.
- </value>
- <remarks>
- By default, standard output messages wil be written to the build log
- with level <see cref="F:NAnt.Core.Level.Info"/>.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ErrorWriter">
- <summary>
- Gets or sets the <see cref="T:System.IO.TextWriter"/> to which error output
- of the external program will be written.
- </summary>
- <value>
- The <see cref="T:System.IO.TextWriter"/> to which error output of the external
- program will be written.
- </value>
- <remarks>
- By default, error output wil be written to the build log with level
- <see cref="F:NAnt.Core.Level.Warning"/>.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ExitCode">
- <summary>
- Gets the value that the process specified when it terminated.
- </summary>
- <value>
- The code that the associated process specified when it terminated,
- or <c>-1000</c> if the process could not be started or did not
- exit (in time).
- </value>
- </member>
- <member name="P:NAnt.Core.Tasks.ExternalProgramBase.CommandLine">
- <summary>
- Gets the command-line arguments, separated by spaces.
- </summary>
- </member>
- <member name="M:NAnt.Core.Tasks.ExecTask.InitializeTask(System.Xml.XmlNode)">
- <summary>
- Performs additional checks after the task has been initialized.
- </summary>
- <param name="taskNode">The <see cref="T:System.Xml.XmlNode"/> used to initialize the task.</param>
- <exception cref="T:NAnt.Core.BuildException"><see cref="P:NAnt.Core.Tasks.ExecTask.FileName"/> does not hold a valid file name.</exception>
- </member>
- <member name="M:NAnt.Core.Tasks.ExecTask.ExecuteTask">
- <summary>
- Executes the external program.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.ExecTask.FileName">
- <summary>
- The program to execute without command arguments.
- </summary>
- <remarks>
- The path will not be evaluated to a full path using the project
- base directory.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Tasks.ExecTask.CommandLineArguments">
- <summary>
- The command-line arguments for the program.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.ExecTask.EnvironmentSet">
- <summary>
- Environment variables to pass to the program.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.ExecTask.WorkingDirectory">
- <summary>
- The directory in which the command will be executed.
- </summary>
- <value>
- The directory in which the command will be executed. The default
- is the project's base directory.
- </value>
- <remarks>
- <para>
- The working directory will be evaluated relative to the project's
- base directory if it is relative.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Core.Tasks.ExecTask.ResultProperty">
- <summary>
- <para>
- The name of a property in which the exit code of the program should
- be stored. Only of interest if <see cref="P:NAnt.Core.Task.FailOnError"/> is
- <see langword="false"/>.
- </para>
- <para>
- If the exit code of the program is "-1000" then the program could
- not be started, or did not exit (in time).
- </para>
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.ExecTask.UseRuntimeEngine">
- <summary>
- Specifies whether the external program should be executed using a
- runtime engine, if configured. The default is <see langword="false" />.
- </summary>
- <value>
- <see langword="true" /> if the external program should be executed
- using a runtime engine; otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.Tasks.ExecTask.ProgramFileName">
- <summary>
- Gets the filename of the external program to start.
- </summary>
- <value>
- The filename of the external program.
- </value>
- </member>
- <member name="P:NAnt.Core.Tasks.ExecTask.ProgramArguments">
- <summary>
- Gets the command-line arguments for the external program.
- </summary>
- <value>
- The command-line arguments for the external program.
- </value>
- </member>
- <member name="P:NAnt.Core.Tasks.ExecTask.BaseDirectory">
- <summary>
- The directory the program is in.
- </summary>
- <remarks>
- <value>
- The directory the program is in. The default is the project's base
- directory.
- </value>
- <para>
- The basedir will be evaluated relative to the project's base
- directory if it is relative.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Core.Tasks.ExecTask.Output">
- <summary>
- The file to which the standard output will be redirected.
- </summary>
- <remarks>
- By default, the standard output is redirected to the console.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Tasks.ExecTask.OutputAppend">
- <summary>
- Gets or sets a value indicating whether output should be appended
- to the output file. The default is <see langword="false"/>.
- </summary>
- <value>
- <see langword="true"/> if output should be appended to the <see cref="P:NAnt.Core.Tasks.ExecTask.Output"/>;
- otherwise, <see langword="false"/>.
- </value>
- </member>
- <member name="T:NAnt.Core.Tasks.FailTask">
- <summary>
- Exits the current build by throwing a <see cref="T:NAnt.Core.BuildException"/>,
- optionally printing additional information.
- </summary>
- <remarks>
- <para>
- The cause of the build failure can be specified using the <see cref="P:NAnt.Core.Tasks.FailTask.Message"/>
- attribute or as inline content.
- </para>
- <para>
- Macros in the message will be expanded.
- </para>
- </remarks>
- <example>
- <para>Exits the current build without giving further information.</para>
- <code>
- <![CDATA[
- <fail />
- ]]>
- </code>
- </example>
- <example>
- <para>Exits the current build and writes a message to the build log.</para>
- <code>
- <![CDATA[
- <fail message="Something wrong here." />
- ]]>
- </code>
- </example>
- <example>
- <para>Functionally equivalent to the previous example.</para>
- <code>
- <![CDATA[
- <fail>Something wrong here.</fail>
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Core.Tasks.FailTask.Message">
- <summary>
- A message giving further information on why the build exited.
- </summary>
- <remarks>
- Inline content and <see cref="P:NAnt.Core.Tasks.FailTask.Message"/> are mutually exclusive.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Tasks.FailTask.Contents">
- <summary>
- Gets or sets the inline content that should be output in the build
- log, giving further information on why the build exited.
- </summary>
- <value>
- The inline content that should be output in the build log.
- </value>
- <remarks>
- Inline content and <see cref="P:NAnt.Core.Tasks.FailTask.Message"/> are mutually exclusive.
- </remarks>
- </member>
- <member name="T:NAnt.Core.Tasks.GetTask">
- <summary>
- Gets a particular file from a URL source.
- </summary>
- <remarks>
- <para>
- Options include verbose reporting and timestamp based fetches.
- </para>
- <para>
- Currently, only HTTP and UNC protocols are supported. FTP support may
- be added when more pluggable protocols are added to the System.Net
- assembly.
- </para>
- <para>
- The <see cref="P:NAnt.Core.Tasks.GetTask.UseTimeStamp"/> option enables you to control downloads
- so that the remote file is only fetched if newer than the local copy.
- If there is no local copy, the download always takes place. When a file
- is downloaded, the timestamp of the downloaded file is set to the remote
- timestamp.
- </para>
- <note>
- This timestamp facility only works on downloads using the HTTP protocol.
- </note>
- </remarks>
- <example>
- <para>
- Gets the index page of the NAnt home page, and stores it in the file
- <c>help/index.html</c> relative to the project base directory.
- </para>
- <code>
- <![CDATA[
- <get src="http://nant.sourceforge.org/" dest="help/index.html" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Gets the index page of a secured web site using the given credentials,
- while connecting using the specified password-protected proxy server.
- </para>
- <code>
- <![CDATA[
- <get src="http://password.protected.site/index.html" dest="secure/index.html">
- <credentials username="user" password="guess" domain="mydomain" />
- <proxy host="proxy.company.com" port="8080">
- <credentials username="proxyuser" password="dunno" />
- </proxy>
- </get>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Tasks.GetTask.InitializeTask(System.Xml.XmlNode)">
- <summary>
- Initializes task and ensures the supplied attributes are valid.
- </summary>
- <param name="taskNode">Xml node used to define this task instance.</param>
- </member>
- <member name="M:NAnt.Core.Tasks.GetTask.ExecuteTask">
- <summary>
- This is where the work is done
- </summary>
- </member>
- <member name="M:NAnt.Core.Tasks.GetTask.TouchFile(System.IO.FileInfo,System.DateTime)">
- <summary>
- Sets the timestamp of a given file to a specified time.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.GetTask.Source">
- <summary>
- The URL from which to retrieve a file.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.GetTask.DestinationFile">
- <summary>
- The file where to store the retrieved file.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.GetTask.HttpProxy">
- <summary>
- If inside a firewall, proxy server/port information
- Format: {proxy server name}:{port number}
- Example: proxy.mycompany.com:8080
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.GetTask.Proxy">
- <summary>
- The network proxy to use to access the Internet resource.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.GetTask.Credentials">
- <summary>
- The network credentials used for authenticating the request with
- the Internet resource.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.GetTask.IgnoreErrors">
- <summary>
- Log errors but don't treat as fatal. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.GetTask.UseTimeStamp">
- <summary>
- Conditionally download a file based on the timestamp of the local
- copy. HTTP only. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.GetTask.Timeout">
- <summary>
- The length of time, in milliseconds, until the request times out.
- The default is <c>100000</c> milliseconds.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.GetTask.Certificates">
- <summary>
- The security certificates to associate with the request.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.IfTask">
- <summary>
- Checks the conditional attributes and executes the children if
- <see langword="true"/>.
- </summary>
- <remarks>
- <para>
- If no conditions are checked, all child tasks are executed.
- </para>
- <para>
- If more than one attribute is used, they are &&'d. The first
- to fail stops the check.
- </para>
- <para>
- The order of condition evaluation is, <see cref="P:NAnt.Core.Tasks.IfTask.TargetNameExists"/>,
- <see cref="P:NAnt.Core.Tasks.IfTask.PropertyNameExists"/>, <see cref="P:NAnt.Core.Tasks.IfTask.PropertyNameTrue"/>,
- <see cref="P:NAnt.Core.Tasks.IfTask.UpToDateFile"/>.
- </para>
- <note>
- instead of using the deprecated attributes, we advise you to use the
- following functions in combination with the <see cref="P:NAnt.Core.Tasks.IfTask.Test"/>
- attribute:
- </note>
- <list type="table">
- <listheader>
- <term>Function</term>
- <description>Description</description>
- </listheader>
- <item>
- <term><see cref="M:NAnt.Core.Functions.PropertyFunctions.Exists(System.String)"/></term>
- <description>Checks whether the specified property exists.</description>
- </item>
- <item>
- <term><see cref="M:NAnt.Core.Functions.TargetFunctions.Exists(System.String)"/></term>
- <description>Checks whether the specified target exists.</description>
- </item>
- </list>
- </remarks>
- <example>
- <para>Tests the value of a property using expressions.</para>
- <code>
- <![CDATA[
- <if test="${build.configuration='release'}">
- <echo>Build release configuration</echo>
- </if>
- ]]>
- </code>
- </example>
- <example>
- <para>Tests the the output of a function.</para>
- <code>
- <![CDATA[
- <if test="${not file::exists(filename) or file::get-length(filename) = 0}">
- <echo message="The version file ${filename} doesn't exist or is empty!" />
- </if>
- ]]>
- </code>
- </example>
- <example>
- <para><c>(Deprecated)</c> Check that a target exists.</para>
- <code>
- <![CDATA[
- <target name="myTarget" />
- <if targetexists="myTarget">
- <echo message="myTarget exists" />
- </if>
- ]]>
- </code>
- </example>
- <example>
- <para><c>(Deprecated)</c> Check existence of a property.</para>
- <code>
- <![CDATA[
- <if propertyexists="myProp">
- <echo message="myProp Exists. Value='${myProp}'" />
- </if>
- ]]>
- </code>
- </example>
- <example>
- <para><c>(Deprecated)</c> Check that a property value is true.</para>
- <code>
- <![CDATA[
- <if propertytrue="myProp">
- <echo message="myProp is true. Value='${myProp}'" />
- </if>
- ]]>
- </code>
- </example>
- <example>
- <para>
- <c>(Deprecated)</c> Check that a property exists and is <see langword="true"/>
- (uses multiple conditions).
- </para>
- <code>
- <![CDATA[
- <if propertyexists="myProp" propertytrue="myProp">
- <echo message="myProp is '${myProp}'" />
- </if>
- ]]>
- </code>
- <para>which is the same as</para>
- <code>
- <![CDATA[
- <if propertyexists="myProp">
- <if propertytrue="myProp">
- <echo message="myProp is '${myProp}'" />
- </if>
- </if>
- ]]>
- </code>
- </example>
- <example>
- <para>
- <c>(Deprecated)</c> Check file dates. If <c>myfile.dll</c> is uptodate,
- then do stuff.
- </para>
- <code>
- <![CDATA[
- <if uptodatefile="myfile.dll" comparefile="myfile.cs">
- <echo message="myfile.dll is newer/same-date as myfile.cs" />
- </if>
- ]]>
- </code>
- <para>or</para>
- <code>
- <![CDATA[
- <if uptodatefile="myfile.dll">
- <comparefiles>
- <include name="*.cs" />
- </comparefiles>
- <echo message="myfile.dll is newer/same-date as myfile.cs" />
- </if>
- ]]>
- </code>
- <para>or</para>
- <code>
- <![CDATA[
- <if>
- <uptodatefiles>
- <include name="myfile.dll" />
- </uptodatefiles>
- <comparefiles>
- <include name="*.cs" />
- </comparefiles>
- <echo message="myfile.dll is newer/same-date as myfile.cs" />
- </if>
- ]]>
- </code>
- </example>
- </member>
- <member name="T:NAnt.Core.TaskContainer">
- <summary>
- Executes embedded tasks in the order in which they are defined.
- </summary>
- </member>
- <member name="M:NAnt.Core.TaskContainer.InitializeTask(System.Xml.XmlNode)">
- <summary>
- Automatically exclude build elements that are defined on the task
- from things that get executed, as they are evaluated normally during
- XML task initialization.
- </summary>
- <param name="taskNode"><see cref="T:System.Xml.XmlNode"/> used to initialize the container.</param>
- </member>
- <member name="M:NAnt.Core.TaskContainer.ExecuteChildTasks">
- <summary>
- Creates and executes the embedded (child XML nodes) elements.
- </summary>
- <remarks>
- Skips any element defined by the host <see cref="T:NAnt.Core.Task"/> that has
- a <see cref="T:NAnt.Core.Attributes.BuildElementAttribute"/> defined.
- </remarks>
- </member>
- <member name="P:NAnt.Core.TaskContainer.CustomXmlProcessing">
- <summary>
- Gets a value indicating whether the element is performing additional
- processing using the <see cref="T:System.Xml.XmlNode"/> that was use to
- initialize the element.
- </summary>
- <value>
- <see langword="true"/>, as a <see cref="T:NAnt.Core.TaskContainer"/> is
- responsable for creating tasks from the nested build elements.
- </value>
- </member>
- <member name="P:NAnt.Core.Tasks.IfTask.UpToDateFile">
- <summary>
- The file to compare if uptodate.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.IfTask.CompareFile">
- <summary>
- The file to check against for the uptodate file.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.IfTask.CompareFiles">
- <summary>
- The <see cref="T:NAnt.Core.Types.FileSet"/> that contains the comparison files for
- the <see cref="P:NAnt.Core.Tasks.IfTask.UpToDateFile"/>(s) check.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.IfTask.UpToDateFiles">
- <summary>
- The <see cref="T:NAnt.Core.Types.FileSet"/> that contains the uptodate files for
- the <see cref="P:NAnt.Core.Tasks.IfTask.CompareFile"/>(s) check.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.IfTask.PropertyNameTrue">
- <summary>
- Used to test whether a property is true.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.IfTask.PropertyNameExists">
- <summary>
- Used to test whether a property exists.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.IfTask.TargetNameExists">
- <summary>
- Used to test whether a target exists.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.IfTask.Test">
- <summary>
- Used to test arbitrary boolean expression.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.IfNotTask">
- <summary>
- The opposite of the <c>if</c> task.
- </summary>
- <example>
- <para>Check that a property does not exist.</para>
- <code>
- <![CDATA[
- <ifnot propertyexists="myProp">
- <echo message="myProp does not exist."/>
- </if>
- ]]>
- </code>
- <para>Check that a property value is not true.</para>
- <code>
- <![CDATA[
- <ifnot propertytrue="myProp">
- <echo message="myProp is not true."/>
- </if>
- ]]>
- </code>
- </example>
- <example>
- <para>Check that a target does not exist.</para>
- <code>
- <![CDATA[
- <ifnot targetexists="myTarget">
- <echo message="myTarget does not exist."/>
- </if>
- ]]>
- </code>
- </example>
- </member>
- <member name="T:NAnt.Core.Tasks.IncludeTask">
- <summary>
- Includes an external build file.
- </summary>
- <remarks>
- <para>
- This task is used to break your build file into smaller chunks. You
- can load a partial build file and have it included into the build file.
- </para>
- <note>
- Any global (project level) tasks in the included build file are executed
- when this task is executed. Tasks in target elements are only executed
- if that target is executed.
- </note>
- <note>
- The project element attributes are ignored.
- </note>
- <note>
- This task can only be in the global (project level) section of the
- build file.
- </note>
- <note>
- This task can only include files from the file system.
- </note>
- </remarks>
- <example>
- <para>
- Include a task that fetches the project version from the
- <c>GetProjectVersion.include</c> build file.
- </para>
- <code>
- <![CDATA[
- <include buildfile="GetProjectVersion.include" />
- ]]>
- </code>
- </example>
- </member>
- <member name="F:NAnt.Core.Tasks.IncludeTask._includedFileNames">
- <summary>
- Used to check for recursived includes.
- </summary>
- </member>
- <member name="M:NAnt.Core.Tasks.IncludeTask.InitializeTask(System.Xml.XmlNode)">
- <summary>
- Verifies parameters.
- </summary>
- <param name="taskNode">Xml taskNode used to define this task instance.</param>
- </member>
- <member name="P:NAnt.Core.Tasks.IncludeTask.BuildFileName">
- <summary>
- Build file to include.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.LoadFileTask">
- <summary>
- Load a text file into a single property.
- </summary>
- <remarks>
- <para>
- Unless an encoding is specified, the encoding associated with the
- system's current ANSI code page is used.
- </para>
- <para>
- An UTF-8, little-endian Unicode, and big-endian Unicode encoded text
- file is automatically recognized, if the file starts with the appropriate
- byte order marks.
- </para>
- </remarks>
- <example>
- <para>
- Load file <c>message.txt</c> into property "message".
- </para>
- <code>
- <![CDATA[
- <loadfile
- file="message.txt"
- property="message" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Load a file using the "latin-1" encoding.
- </para>
- <code>
- <![CDATA[
- <loadfile
- file="loadfile.xml"
- property="encoded-file"
- encoding="iso-8859-1" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Load a file, replacing all <c>@NOW@</c> tokens with the current
- date/time.
- </para>
- <code>
- <![CDATA[
- <loadfile file="token.txt" property="token-file">
- <filterchain>
- <replacetokens>
- <token key="NOW" value="${datetime::now()}" />
- </replacetokens>
- </filterchain>
- </loadfile>
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Core.Tasks.LoadFileTask.File">
- <summary>
- The file to load.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.LoadFileTask.Property">
- <summary>
- The name of the property to save the content to.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.LoadFileTask.Encoding">
- <summary>
- The encoding to use when loading the file. The default is the encoding
- associated with the system's current ANSI code page.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.LoadFileTask.FilterChain">
- <summary>
- The filterchain definition to use.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.LoadTasksTask">
- <summary>
- Loads tasks form a given assembly or all assemblies in a given directory
- or <see cref="T:NAnt.Core.Types.FileSet"/>.
- </summary>
- <example>
- <para>
- Load tasks from a single assembly.
- </para>
- <code>
- <![CDATA[
- <loadtasks assembly="c:foo\NAnt.Contrib.Tasks.dll" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Scan a single directory for task assemblies.
- </para>
- <code>
- <![CDATA[
- <loadtasks path="c:\foo" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Use a <see cref="P:NAnt.Core.Tasks.LoadTasksTask.TaskFileSet"/> containing both a directory and an
- assembly.
- </para>
- <code>
- <![CDATA[
- <loadtasks>
- <fileset>
- <include name="C:\cvs\NAntContrib\build" />
- <include name="C:\cvs\NAntContrib\build\NAnt.Contrib.Tasks.dll" />
- </fileset>
- </loadtasks>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Tasks.LoadTasksTask.ExecuteTask">
- <summary>
- Executes the Load Tasks task.
- </summary>
- <exception cref="T:NAnt.Core.BuildException">Specified assembly or path does not exist.</exception>
- </member>
- <member name="M:NAnt.Core.Tasks.LoadTasksTask.InitializeTask(System.Xml.XmlNode)">
- <summary>
- Validates the attributes.
- </summary>
- <exception cref="T:NAnt.Core.BuildException">Both <see cref="P:NAnt.Core.Tasks.LoadTasksTask.AssemblyPath"/> and <see cref="P:NAnt.Core.Tasks.LoadTasksTask.Path"/> are set.</exception>
- </member>
- <member name="P:NAnt.Core.Tasks.LoadTasksTask.AssemblyPath">
- <summary>
- An assembly to load tasks from.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.LoadTasksTask.Path">
- <summary>
- A directory to scan for task assemblies.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.LoadTasksTask.TaskFileSet">
- <summary>
- Used to select which directories or individual assemblies to scan.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.LoopTask">
- <summary>
- Loops over a set of items.
- </summary>
- <remarks>
- <para>
- Can loop over files in directory, lines in a file, etc.
- </para>
- <para>
- The property value is stored before the loop is done, and restored
- when the loop is finished.
- </para>
- <para>
- The property is returned to its normal value once it is used. Read-only
- parameters cannot be overridden in this loop.
- </para>
- </remarks>
- <example>
- <para>Loops over the files in <c>c:\</c>.</para>
- <code>
- <![CDATA[
- <foreach item="File" in="c:\" property="filename">
- <echo message="${filename}" />
- </foreach>
- ]]>
- </code>
- </example>
- <example>
- <para>Loops over all files in the project directory.</para>
- <code>
- <![CDATA[
- <foreach item="File" property="filename">
- <in>
- <items>
- <include name="**" />
- </items>
- </in>
- <do>
- <echo message="${filename}" />
- </do>
- </foreach>
- ]]>
- </code>
- </example>
- <example>
- <para>Loops over the folders in <c>c:\</c>.</para>
- <code>
- <![CDATA[
- <foreach item="Folder" in="c:\" property="foldername">
- <echo message="${foldername}" />
- </foreach>
- ]]>
- </code>
- </example>
- <example>
- <para>Loops over all folders in the project directory.</para>
- <code>
- <![CDATA[
- <foreach item="Folder" property="foldername">
- <in>
- <items>
- <include name="**" />
- </items>
- </in>
- <do>
- <echo message="${foldername}" />
- </do>
- </foreach>
- ]]>
- </code>
- </example>
- <example>
- <para>Loops over a list.</para>
- <code>
- <![CDATA[
- <foreach item="String" in="1 2,3" delim=" ," property="count">
- <echo message="${count}" />
- </foreach>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Loops over lines in the file <c>properties.csv</c>, where each line
- is of the format name,value.
- </para>
- <code>
- <![CDATA[
- <foreach item="Line" in="properties.csv" delim="," property="x,y">
- <echo message="Read pair ${x}=${y}" />
- </foreach>
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Core.Tasks.LoopTask.Property">
- <summary>
- The NAnt property name(s) that should be used for the current
- iterated item.
- </summary>
- <remarks>
- If specifying multiple properties, separate them with a comma.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Tasks.LoopTask.ItemType">
- <summary>
- The type of iteration that should be done.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.LoopTask.TrimType">
- <summary>
- The type of whitespace trimming that should be done. The default
- is <see cref="F:NAnt.Core.Tasks.LoopTask.LoopTrim.None"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.LoopTask.Source">
- <summary>
- The source of the iteration.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.LoopTask.Delimiter">
- <summary>
- The deliminator char.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.LoopTask.InElement">
- <summary>
- Stuff to operate in. Just like the <see cref="P:NAnt.Core.Tasks.LoopTask.Source"/>
- attribute, but supports more complicated things like a <see cref="T:NAnt.Core.Types.FileSet"/>
- and such.
- <note>
- Please remove the <see cref="P:NAnt.Core.Tasks.LoopTask.Source"/> attribute if you
- are using this element.
- </note>
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.LoopTask.StuffToDo">
- <summary>
- Tasks to execute for each matching item.
- </summary>
- </member>
- <member name="F:NAnt.Core.Tasks.LoopTask.LoopTrim.None">
- <summary>
- Do not remove any white space characters.
- </summary>
- </member>
- <member name="F:NAnt.Core.Tasks.LoopTask.LoopTrim.End">
- <summary>
- Remove all white space characters from the end of the current
- item.
- </summary>
- </member>
- <member name="F:NAnt.Core.Tasks.LoopTask.LoopTrim.Start">
- <summary>
- Remove all white space characters from the beginning of the
- current item.
- </summary>
- </member>
- <member name="F:NAnt.Core.Tasks.LoopTask.LoopTrim.Both">
- <summary>
- Remove all white space characters from the beginning and end of
- the current item.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.MailTask">
- <summary>
- Sends an SMTP message.
- </summary>
- <remarks>
- <para>
- Text and text files to include in the message body may be specified as
- well as binary attachments.
- </para>
- </remarks>
- <example>
- <para>
- Sends an email from <c>nant@sourceforge.net</c> to three recipients
- with a subject about the attachments. The body of the message will be
- the combined contents of all <c>.txt</c> files in the base directory.
- All zip files in the base directory will be included as attachments.
- The message will be sent using the <c>smtpserver.anywhere.com</c> SMTP
- server.
- </para>
- <code>
- <![CDATA[
- <mail
- from="nant@sourceforge.net"
- tolist="recipient1@sourceforge.net"
- cclist="recipient2@sourceforge.net"
- bcclist="recipient3@sourceforge.net"
- subject="Msg 7: With attachments"
- mailhost="smtpserver.anywhere.com">
- <files>
- <include name="*.txt" />
- </files>
- <attachments>
- <include name="*.zip" />
- </attachments>
- </mail>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Tasks.MailTask.InitializeTask(System.Xml.XmlNode)">
- <summary>
- Initializes task and ensures the supplied attributes are valid.
- </summary>
- <param name="taskNode">Xml node used to define this task instance.</param>
- </member>
- <member name="M:NAnt.Core.Tasks.MailTask.ExecuteTask">
- <summary>
- This is where the work is done.
- </summary>
- </member>
- <member name="M:NAnt.Core.Tasks.MailTask.ReadFile(System.String)">
- <summary>
- Reads a text file and returns the content
- in a string.
- </summary>
- <param name="filename">The file to read content of.</param>
- <returns>
- The content of the specified file.
- </returns>
- </member>
- <member name="P:NAnt.Core.Tasks.MailTask.From">
- <summary>
- Email address of sender.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.MailTask.ToList">
- <summary>
- Semicolon-separated list of recipient email addresses.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.MailTask.CcList">
- <summary>
- Semicolon-separated list of CC: recipient email addresses.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.MailTask.BccList">
- <summary>
- Semicolon-separated list of BCC: recipient email addresses.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.MailTask.Mailhost">
- <summary>
- Host name of mail server. The default is <c>localhost</c>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.MailTask.Message">
- <summary>
- Text to send in body of email message.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.MailTask.Subject">
- <summary>
- Text to send in subject line of email message.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.MailTask.Format">
- <summary>
- Format of the message. The default is <see cref="F:System.Web.Mail.MailFormat.Text"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.MailTask.Files">
- <summary>
- Files that are transmitted as part of the body of the email message.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.MailTask.Attachments">
- <summary>
- Attachments that are transmitted with the message.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.MkDirTask">
- <summary>
- Creates a directory and any non-existent parent directory if necessary.
- </summary>
- <example>
- <para>Create the directory <c>build</c>.</para>
- <code>
- <![CDATA[
- <mkdir dir="build" />
- ]]>
- </code>
- </example>
- <example>
- <para>Create the directory tree <c>one/two/three</c>.</para>
- <code>
- <![CDATA[
- <mkdir dir="one/two/three" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Tasks.MkDirTask.ExecuteTask">
- <summary>
- Creates the directory specified by the <see cref="P:NAnt.Core.Tasks.MkDirTask.Dir"/> property.
- </summary>
- <exception cref="T:NAnt.Core.BuildException">The directory could not be created.</exception>
- </member>
- <member name="P:NAnt.Core.Tasks.MkDirTask.Dir">
- <summary>
- The directory to create.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.MoveTask">
- <summary>
- Moves a file or set of files to a new file or directory.
- </summary>
- <remarks>
- <para>
- Files are only moved if the source file is newer than the destination
- file, or if the destination file does not exist. However, you can
- explicitly overwrite files with the <see cref="P:NAnt.Core.Tasks.CopyTask.Overwrite"/>
- attribute.
- </para>
- <para>
- A <see cref="T:NAnt.Core.Types.FileSet"/> can be used to select files to move. To use
- a <see cref="T:NAnt.Core.Types.FileSet"/>, the <see cref="P:NAnt.Core.Tasks.CopyTask.ToDirectory"/>
- attribute must be set.
- </para>
- <h3>Encoding</h3>
- <para>
- Unless an encoding is specified, the encoding associated with the
- system's current ANSI code page is used.
- </para>
- <para>
- An UTF-8, little-endian Unicode, and big-endian Unicode encoded text
- file is automatically recognized, if the file starts with the
- appropriate byte order marks.
- </para>
- <note>
- If you employ filters in your move operation, you should limit the
- move to text files. Binary files will be corrupted by the move
- operation.
- </note>
- </remarks>
- <example>
- <para>
- Move a single file while changing its encoding from "latin1" to
- "utf-8".
- </para>
- <code>
- <![CDATA[
- <move
- file="myfile.txt"
- tofile="mycopy.txt"
- inputencoding="latin1"
- outputencoding="utf-8" />
- ]]>
- </code>
- </example>
- <example>
- <para>Move a set of files.</para>
- <code>
- <![CDATA[
- <move todir="${build.dir}">
- <fileset basedir="bin">
- <include name="*.dll" />
- </fileset>
- </move>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Move a set of files to a directory, replacing <c>@TITLE@</c> with
- "Foo Bar" in all files.
- </para>
- <code>
- <![CDATA[
- <move todir="../backup/dir">
- <fileset basedir="src_dir">
- <include name="**/*" />
- </fileset>
- <filterchain>
- <replacetokens>
- <token key="TITLE" value="Foo Bar" />
- </replacetokens>
- </filterchain>
- </move>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Tasks.MoveTask.DoFileOperations">
- <summary>
- Actually does the file moves.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.MoveTask.SourceFile">
- <summary>
- The file to move.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.MoveTask.ToFile">
- <summary>
- The file to move to.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.MoveTask.ToDirectory">
- <summary>
- The directory to move to.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.MoveTask.CopyFileSet">
- <summary>
- Used to select the files to move. To use a <see cref="T:NAnt.Core.Types.FileSet"/>,
- the <see cref="P:NAnt.Core.Tasks.MoveTask.ToDirectory"/> attribute must be set.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.MoveTask.Flatten">
- <summary>
- Ignore directory structure of source directory, move all files into
- a single directory, specified by the <see cref="P:NAnt.Core.Tasks.MoveTask.ToDirectory"/>
- attribute. The default is <see langword="false"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.MoveTask.Filters">
- <summary>
- Chain of filters used to alter the file's content as it is moved.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.NAntSchemaTask">
- <summary>
- Creates an XSD File for all available tasks.
- </summary>
- <remarks>
- <para>
- This can be used in conjuntion with the command-line option to do XSD
- Schema validation on the build file.
- </para>
- </remarks>
- <example>
- <para>Creates a <c>NAnt.xsd</c> file in the current project directory.</para>
- <code>
- <![CDATA[
- <nantschema output="NAnt.xsd" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Tasks.NAntSchemaTask.WriteSchema(System.IO.Stream,System.Type[],System.Type[],System.String)">
- <summary>
- Creates a NAnt Schema for given types
- </summary>
- <param name="stream">The output stream to save the schema to. If <see langword="null" />, writing is ignored, no exception generated.</param>
- <param name="tasks">The list of tasks to generate XML Schema for.</param>
- <param name="dataTypes">The list of datatypes to generate XML Schema for.</param>
- <param name="targetNS">The target namespace to output.</param>
- <returns>The new NAnt Schema.</returns>
- </member>
- <member name="M:NAnt.Core.Tasks.NAntSchemaTask.CreateXsdAttribute(System.String,System.Boolean)">
- <summary>
- Creates a new <see cref="T:System.Xml.Schema.XmlSchemaAttribute"/> instance.
- </summary>
- <param name="name">The name of the attribute.</param>
- <param name="required">Value indicating whether the attribute should be required.</param>
- <returns>The new <see cref="T:System.Xml.Schema.XmlSchemaAttribute"/> instance.</returns>
- </member>
- <member name="M:NAnt.Core.Tasks.NAntSchemaTask.CreateXsdSequence(System.Decimal,System.Decimal)">
- <summary>
- Creates a new <see cref="T:System.Xml.Schema.XmlSchemaSequence"/> instance.
- </summary>
- <param name="min">The minimum value to allow for this choice</param>
- <param name="max">The maximum value to allow, Decimal.MaxValue sets it to 'unbound'</param>
- <returns>The new <see cref="T:System.Xml.Schema.XmlSchemaSequence"/> instance.</returns>
- </member>
- <member name="P:NAnt.Core.Tasks.NAntSchemaTask.OutputFile">
- <summary>
- The name of the output file to which the XSD should be written.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.NAntSchemaTask.TargetNamespace">
- <summary>
- The target namespace for the output. Defaults to "http://tempuri.org/nant-donotuse.xsd"
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.NAntSchemaTask.ForType">
- <summary>
- The <see cref="T:System.Type"/> for which an XSD should be created. If not
- specified, an XSD will be created for all available tasks.
- </summary>
- </member>
- <member name="M:NAnt.Core.Tasks.NAntSchemaTask.NAntSchemaGenerator.#ctor(System.Type[],System.Type[],System.String)">
- <summary>
- Creates a new instance of the <see cref="T:NAnt.Core.Tasks.NAntSchemaTask.NAntSchemaGenerator"/>
- class.
- </summary>
- <param name="tasks">Tasks for which a schema should be generated.</param>
- <param name="dataTypes">Data Types for which a schema should be generated.</param>
- <param name="targetNS">The namespace to use.
- <example> http://tempuri.org/nant.xsd </example>
- </param>
- </member>
- <member name="T:NAnt.Core.Tasks.NAntTask">
- <summary>
- Runs NAnt on a supplied build file, or a set of build files.
- </summary>
- <remarks>
- <para>
- By default, all the properties of the current project will be available
- in the new project. Alternatively, you can set <see cref="P:NAnt.Core.Tasks.NAntTask.InheritAll"/>
- to <see langword="false"/> to not copy any properties to the new
- project.
- </para>
- <para>
- You can also set properties in the new project from the old project by
- using nested property tags. These properties are always passed to the
- new project regardless of the setting of <see cref="P:NAnt.Core.Tasks.NAntTask.InheritAll"/>.
- This allows you to parameterize your subprojects.
- </para>
- <para>
- References to data types can also be passed to the new project, but by
- default they are not. If you set the <see cref="P:NAnt.Core.Tasks.NAntTask.InheritRefs"/> to
- <see langword="true"/>, all references will be copied.
- </para>
- </remarks>
- <example>
- <para>
- Build a project located in a different directory if the <c>debug</c>
- property is not <see langword="true"/>.
- </para>
- <code>
- <![CDATA[
- <nant buildfile="${src.dir}/Extras/BuildServer/BuildServer.build" unless="${debug}" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Build a project while adding a set of properties to that project.
- </para>
- <code>
- <![CDATA[
- <nant buildfile="${src.dir}/Extras/BuildServer/BuildServer.build">
- <properties>
- <property name="build.dir" value="c:/buildserver" />
- <property name="build.debug" value="false" />
- <property name="lib.dir" value="c:/shared/lib" readonly="true" />
- </properties>
- </nant>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Build all projects named <c>default.build</c> located anywhere under
- the project base directory.
- </para>
- <code>
- <![CDATA[
- <nant>
- <buildfiles>
- <include name="**/default.build" />
- <!-- avoid recursive execution of current build file -->
- <exclude name="${project::get-buildfile-path()}" />
- </buildfiles>
- </nant>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Tasks.NAntTask.InitializeTask(System.Xml.XmlNode)">
- <summary>
- Validates the <see cref="T:NAnt.Core.Tasks.NAntTask"/> element.
- </summary>
- <param name="taskNode">The XML node of the task to use for initialization.</param>
- </member>
- <member name="P:NAnt.Core.Tasks.NAntTask.BuildFile">
- <summary>
- The build file to build.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.NAntTask.DefaultTarget">
- <summary>
- The target to execute. To specify more than one target seperate
- targets with a space. Targets are executed in order if possible.
- The default is to use target specified in the project's default
- attribute.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.NAntTask.BuildFiles">
- <summary>
- Used to specify a set of build files to process.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.NAntTask.InheritAll">
- <summary>
- Specifies whether current property values should be inherited by
- the executed project. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.NAntTask.InheritRefs">
- <summary>
- Specifies whether all references will be copied to the new project.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.NAntTask.OverrideProperties">
- <summary>
- Specifies a collection of properties that should be created in the
- executed project. Note, existing properties with identical names
- that are not read-only will be overwritten.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.PropertyTask">
- <summary>
- Sets a property in the current project.
- </summary>
- <remarks>
- <note>NAnt uses a number of predefined properties.</note>
- </remarks>
- <example>
- <para>
- Define a <c>debug</c> property with value <see langword="true" />.
- </para>
- <code>
- <![CDATA[
- <property name="debug" value="true" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Use the user-defined <c>debug</c> property.
- </para>
- <code>
- <![CDATA[
- <property name="trace" value="${debug}" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Define a read-only property. This is just like passing in the param
- on the command line.
- </para>
- <code>
- <![CDATA[
- <property name="do_not_touch_ME" value="hammer" readonly="true" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Define a property, but do not overwrite the value if the property already exists (eg. it was specified on the command line).
- </para>
- <code>
- <![CDATA[
- <project name="property-example">
- <property name="debug" value="true" overwrite="false" />
- <echo message="debug: ${debug}" />
- </project>
- ]]>
- </code>
- <para>
- Executing this build file with the command line option <c>-D:debug=false</c>,
- would cause the value specified on the command line to remain unaltered.
- </para>
- <code>
- <![CDATA[
- [echo] debug: false
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Core.Tasks.PropertyTask.PropertyName">
- <summary>
- The name of the NAnt property to set.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.PropertyTask.Value">
- <summary>
- The value to assign to the NAnt property.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.PropertyTask.ReadOnly">
- <summary>
- Specifies whether the property is read-only or not.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.PropertyTask.Dynamic">
- <summary>
- Specifies whether references to other properties should not be
- expanded when the value of the property is set, but expanded when
- the property is actually used. By default, properties will be
- expanded when set.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.PropertyTask.Overwrite">
- <summary>
- Specifies whether the value of a property should be overwritten if
- the property already exists (unless the property is read-only).
- The default is <see langword="true" />.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.RegexTask">
- <summary>
- Sets project properties based on the evaluatuion of a regular expression.
- </summary>
- <remarks>
- <para>
- The <see cref="P:NAnt.Core.Tasks.RegexTask.Pattern"/> attribute must contain one or more
- <see href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpcongroupingconstructs.asp">
- named grouping constructs</see>, which represents the names of the
- properties to be set. These named grouping constructs can be enclosed
- by angle brackets (?<name>) or single quotes (?'name').
- </para>
- <note>
- In the build file, use the XML element <![CDATA[<]]> to specify <,
- and <![CDATA[>]]> to specify >.
- </note>
- <note>
- The named grouping construct must not contain any punctuation and it
- cannot begin with a number.
- </note>
- </remarks>
- <example>
- <para>
- Find the last word in the given string and stores it in the property
- <c>lastword</c>.
- </para>
- <code>
- <![CDATA[
- <regex pattern="(?'lastword'\w+)$" input="This is a test sentence" />
- <echo message="${lastword}" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Split the full filename and extension of a filename.
- </para>
- <code>
- <![CDATA[
- <regex pattern="^(?'filename'.*)\.(?'extension'\w+)$" input="d:\Temp\SomeDir\SomeDir\bla.xml" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Split the path and the filename. (This checks for <c>/</c> or <c>\</c>
- as the path separator).
- </para>
- <code>
- <![CDATA[
- <regex pattern="^(?'path'.*(\\|/)|(/|\\))(?'file'.*)$" input="d:\Temp\SomeDir\SomeDir\bla.xml" />
- ]]>
- </code>
- <para>
- Results in path=<c>d:\Temp\SomeDir\SomeDir\</c> and file=<c>bla.xml</c>.
- </para>
- </example>
- </member>
- <member name="M:NAnt.Core.Tasks.RegexTask.ExecuteTask">
- <summary>
- Executes the task.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.RegexTask.Pattern">
- <summary>
- Represents the regular expression to be evalued.
- </summary>
- <value>
- The regular expression to be evalued.
- </value>
- <remarks>
- The pattern must contain one or more named constructs, which may
- not contain any punctuation and cannot begin with a number.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Tasks.RegexTask.Options">
- <summary>
- A comma separated list of options to pass to the regex engine. The
- default is <see cref="F:System.Text.RegularExpressions.RegexOptions.None"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.RegexTask.Input">
- <summary>
- Represents the input for the regular expression.
- </summary>
- <value>
- The input for the regular expression.
- </value>
- </member>
- <member name="T:NAnt.Core.Tasks.SetEnvTask">
- <summary>
- Sets an environment variable or a whole collection of them. Use an empty
- <see cref="P:NAnt.Core.Tasks.SetEnvTask.LiteralValue"/> attribute to clear a variable.
- </summary>
- <remarks>
- <note>
- Variables will be set for the current NAnt process and all child
- processes that NAnt spawns (compilers, shell tools, etc). If the
- intention is to only set a variable for a single child process, then
- using the <see cref="T:NAnt.Core.Tasks.ExecTask"/> and its nested <see cref="P:NAnt.Core.Tasks.ExecTask.EnvironmentSet"/>
- element might be a better option.
- </note>
- <note>
- Expansion of inline environment variables is performed using the syntax
- of the current platform. So on Windows platforms using the string %PATH%
- in the <see cref="P:NAnt.Core.Tasks.SetEnvTask.LiteralValue"/> attribute will result in the value of
- the PATH variable being expanded in place before the variable is set.
- </note>
- </remarks>
- <example>
- <para>Set the MONO_PATH environment variable on a *nix platform.</para>
- <code>
- <![CDATA[
- <setenv name=="MONO_PATH" value="/home/jimbob/dev/foo:%MONO_PATH%"/>
- ]]>
- </code>
- </example>
- <example>
- <para>Set a collection of environment variables. Note the nested variable used to set var3.</para>
- <code>
- <![CDATA[
- <setenv>
- <variable name="var1" value="value2" />
- <variable name="var2" value="value2" />
- <variable name="var3" value="value3:%var2%" />
- </setenv>
- ]]>
- </code>
- </example>
- <example>
- <para>Set environment variables using nested path elements.</para>
- <code>
- <![CDATA[
- <path id="build.path">
- <pathelement dir="c:/windows" />
- <pathelement dir="c:/cygwin/usr/local/bin" />
- </path>
- <setenv>
- <variable name="build_path" >
- <path refid="build.path" />
- </variable>
- <variable name="path2">
- <path>
- <pathelement dir="c:/windows" />
- <pathelement dir="c:/cygwin/usr/local/bin" />
- </path>
- </variable>
- </setenv>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Tasks.SetEnvTask.SetEnvironmentVariable(System.String,System.String)">
- <summary>
- Win32 DllImport for the SetEnvironmentVariable function.
- </summary>
- <param name="lpName"></param>
- <param name="lpValue"></param>
- <returns></returns>
- </member>
- <member name="M:NAnt.Core.Tasks.SetEnvTask.setenv(System.String,System.String,System.Int32)">
- <summary>
- *nix dllimport for the setenv function.
- </summary>
- <param name="name"></param>
- <param name="value"></param>
- <param name="overwrite"></param>
- <returns></returns>
- </member>
- <member name="M:NAnt.Core.Tasks.SetEnvTask.InitializeTask(System.Xml.XmlNode)">
- <summary>
- Checks whether the task is initialized with valid attributes.
- </summary>
- <param name="taskNode"></param>
- </member>
- <member name="M:NAnt.Core.Tasks.SetEnvTask.ExecuteTask">
- <summary>
- Set the environment variables
- </summary>
- </member>
- <member name="M:NAnt.Core.Tasks.SetEnvTask.SetSingleEnvironmentVariable(System.String,System.String)">
- <summary>
- Do the actual work here.
- </summary>
- <param name="name">The name of the environment variable.</param>
- <param name="value">The value of the environment variable.</param>
- </member>
- <member name="P:NAnt.Core.Tasks.SetEnvTask.EnvName">
- <summary>
- The name of a single Environment variable to set
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.SetEnvTask.LiteralValue">
- <summary>
- The literal value for the environment variable.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.SetEnvTask.File">
- <summary>
- The value for a file-based environment variable. NAnt will convert
- it to an absolute filename.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.SetEnvTask.Directory">
- <summary>
- The value for a directory-based environment variable. NAnt will
- convert it to an absolute path.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.SetEnvTask.Path">
- <summary>
- The value for a PATH like environment variable. You can use
- <c>:</c> or <c>;</c> as path separators and NAnt will convert it to
- the platform's local conventions.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.SleepTask">
- <summary>
- A task for sleeping a specified period of time, useful when a build or deployment process
- requires an interval between tasks.
- </summary>
- <example>
- <para>Sleep 1 hour, 2 minutes, 3 seconds and 4 milliseconds.</para>
- <code>
- <![CDATA[
- <sleep hours="1" minutes="2" seconds="3" milliseconds="4" />
- ]]>
- </code>
- </example>
- <example>
- <para>Sleep 123 milliseconds.</para>
- <code>
- <![CDATA[
- <sleep milliseconds="123" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Tasks.SleepTask.InitializeTask(System.Xml.XmlNode)">
- <summary>
- Verify parameters.
- </summary>
- <param name="taskNode"> taskNode used to define this task instance </param>
- </member>
- <member name="M:NAnt.Core.Tasks.SleepTask.GetSleepTime">
- <summary>
- Return time to sleep.
- </summary>
- </member>
- <member name="M:NAnt.Core.Tasks.SleepTask.DoSleep(System.Int32)">
- <summary>
- Sleeps for the specified number of milliseconds.
- </summary>
- <param name="millis">Number of milliseconds to sleep.</param>
- </member>
- <member name="P:NAnt.Core.Tasks.SleepTask.Hours">
- <summary>
- Hours to add to the sleep time.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.SleepTask.Minutes">
- <summary>
- Minutes to add to the sleep time.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.SleepTask.Seconds">
- <summary>
- Seconds to add to the sleep time.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.SleepTask.Milliseconds">
- <summary>
- Milliseconds to add to the sleep time.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.StyleTask">
- <summary>
- Processes a document via XSLT.
- </summary>
- <example>
- <para>Create a report in HTML.</para>
- <code>
- <![CDATA[
- <style style="report.xsl" in="data.xml" out="report.html" />
- ]]>
- </code>
- </example>
- <example>
- <para>Create a report in HTML, with a param.</para>
- <code>
- <![CDATA[
- <style style="report.xsl" in="data.xml" out="report.html">
- <parameters>
- <parameter name="reportType" namespaceuri="" value="Plain" />
- </parameters>
- </style>
- ]]>
- </code>
- </example>
- <example>
- <para>Create a report in HTML, with a expanded param.</para>
- <code>
- <![CDATA[
- <style style="report.xsl" in="data.xml" out="report.html">
- <parameters>
- <parameter name="reportType" namespaceuri="" value="${report.type}" />
- </parameters>
- </style>
- ]]>
- </code>
- </example>
- <example>
- <para>Create some code based on a directory of templates.</para>
- <code>
- <![CDATA[
- <style style="CodeGenerator.xsl" extension="java">
- <infiles>
- <include name="*.xml" />
- </infiles>
- <parameters>
- <parameter name="reportType" namespaceuri="" value="Plain" if="${report.plain}" />
- </parameters>
- <style>
- ]]>
- </code>
- </example>
- <example>
- <para>Create a report in HTML, with an extension object.</para>
- <code>
- <![CDATA[
- <style style="report.xsl" in="data.xml" out="report.html">
- <extensionobjects>
- <extensionobject namespaceuri="urn:Formatter" typename="XsltExtensionObjects.Formatter" assembly="XsltExtensionObjects.dll" />
- </extensionobjects>
- </style>
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Core.Tasks.StyleTask.DestDir">
- <summary>
- Directory in which to store the results. The default is the project
- base directory.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.StyleTask.Extension">
- <summary>
- Desired file extension to be used for the targets. The default is
- <c>html</c>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.StyleTask.XsltFile">
- <summary>
- URI or path that points to the stylesheet to use. If given as path, it can
- be relative to the project's basedir or absolute.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.StyleTask.SrcFile">
- <summary>
- Specifies a single XML document to be styled. Should be used with
- the <see cref="P:NAnt.Core.Tasks.StyleTask.OutputFile"/> attribute.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.StyleTask.OutputFile">
- <summary>
- Specifies the output name for the styled result from the <see cref="P:NAnt.Core.Tasks.StyleTask.SrcFile"/>
- attribute.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.StyleTask.InFiles">
- <summary>
- Specifies a group of input files to which to apply the stylesheet.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.StyleTask.Parameters">
- <summary>
- XSLT parameters to be passed to the XSLT transformation.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.StyleTask.ExtensionObjects">
- <summary>
- XSLT extension objects to be passed to the XSLT transformation.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.StyleTask.Proxy">
- <summary>
- The network proxy to use to access the Internet resource.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.SysInfoTask">
- <summary>
- Sets properties with system information.
- </summary>
- <remarks>
- <para>Sets a number of properties with information about the system environment. The intent of this task is for nightly build logs to have a record of system information so that the build was performed on.</para>
- <list type="table">
- <listheader>
- <term>Property</term>
- <description>Value</description>
- </listheader>
- <item>
- <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.clr.version</term>
- <description>Common Language Runtime version number.</description>
- </item>
- <item>
- <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.env.*</term>
- <description>Environment variables (e.g., <<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.env.PATH).</description>
- </item>
- <item>
- <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.platform</term>
- <description>Operating system platform ID.</description>
- </item>
- <item>
- <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.version</term>
- <description>Operating system version.</description>
- </item>
- <item>
- <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os</term>
- <description>Operating system version string.</description>
- </item>
- <item>
- <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.folder.applicationdata</term>
- <description>The directory that serves as a common repository for application-specific data for the current roaming user.</description>
- </item>
- <item>
- <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.folder.commonapplicationdata</term>
- <description>The directory that serves as a common repository for application-specific data that is used by all users.</description>
- </item>
- <item>
- <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.folder.commonprogramfiles</term>
- <description>The directory for components that are shared across applications.</description>
- </item>
- <item>
- <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.folder.desktopdirectory</term>
- <description>The directory used to physically store file objects on the desktop. Do not confuse this directory with the desktop folder itself, which is a virtual folder.</description>
- </item>
- <item>
- <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.folder.programfiles</term>
- <description>The Program Files directory.</description>
- </item>
- <item>
- <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.folder.system</term>
- <description>The System directory.</description>
- </item>
- <item>
- <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.folder.temp</term>
- <description>The temporary directory.</description>
- </item>
- </list>
- <para>
- When the name of an environment variable is not a valid property name,
- the task will fail. In that case, set <see cref="P:NAnt.Core.Task.FailOnError"/> to
- <see langword="true"/> to allow that environment variable to be
- skipped.
- </para>
- <note>
- we advise you to use the following functions instead:
- </note>
- <list type="table">
- <listheader>
- <term>Function</term>
- <description>Description</description>
- </listheader>
- <item>
- <term><see cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetOperatingSystem"/></term>
- <description>Gets a <see cref="T:System.OperatingSystem"/> object that identifies this operating system.</description>
- </item>
- <item>
- <term><see cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetFolderPath(System.Environment.SpecialFolder)"/></term>
- <description>Gets the path to a system special folder.</description>
- </item>
- <item>
- <term><see cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVariable(System.String)"/></term>
- <description>Returns the value of a environment variable.</description>
- </item>
- <item>
- <term><see cref="M:NAnt.Core.Functions.PathFunctions.GetTempPath"/></term>
- <description>Gets the path to the temporary directory.</description>
- </item>
- <item>
- <term><see cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/></term>
- <description>Gets the Common Language Runtime version.</description>
- </item>
- </list>
- </remarks>
- <example>
- <para>Register the properties with the default property prefix.</para>
- <code>
- <![CDATA[
- <sysinfo />
- ]]>
- </code>
- </example>
- <example>
- <para>Register the properties without a prefix.</para>
- <code>
- <![CDATA[
- <sysinfo prefix="" />
- ]]>
- </code>
- </example>
- <example>
- <para>Register properties and display a summary.</para>
- <code>
- <![CDATA[
- <sysinfo verbose="true" />
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Core.Tasks.SysInfoTask.Prefix">
- <summary>
- The string to prefix the property names with. The default is "sys.".
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.TStampTask">
- <summary>
- Sets properties with the current date and time.
- </summary>
- <remarks>
- <para>
- By default the <see cref="T:NAnt.Core.Tasks.TStampTask"/> displays the current date
- and time and sets the following properties:
- </para>
- <list type="bullet">
- <item><description>tstamp.date to yyyyMMdd</description></item>
- <item><description>tstamp.time to HHmm</description></item>
- <item><description>tstamp.now using the default DateTime.ToString() method</description></item>
- </list>
- <para>
- To set an additional property with a custom date/time use the
- <see cref="P:NAnt.Core.Tasks.TStampTask.Property"/> and <see cref="P:NAnt.Core.Tasks.TStampTask.Pattern"/> attributes.
- To set a number of additional properties with the exact same date and
- time use the <see cref="P:NAnt.Core.Tasks.TStampTask.Formatters"/> nested element (see example).
- </para>
- <para>
- The date and time string displayed by the <see cref="T:NAnt.Core.Tasks.TStampTask"/>
- uses the computer's default long date and time string format. You
- might consider setting these to the
- <see href="http://www.cl.cam.ac.uk/~mgk25/iso-time.html">ISO 8601 standard
- for date and time notation</see>.
- </para>
- </remarks>
- <example>
- <para>Set the <c>build.date</c> property.</para>
- <code>
- <![CDATA[
- <tstamp property="build.date" pattern="yyyyMMdd" verbose="true" />
- ]]>
- </code>
- </example>
- <example>
- <para>Set a number of properties for Ant like compatibility.</para>
- <code>
- <![CDATA[
- <tstamp verbose="true">
- <formatter property="TODAY" pattern="dd MMM yyyy"/>
- <formatter property="DSTAMP" pattern="yyyyMMdd" unless="${date.not.needed}" />
- <formatter property="TSTAMP" pattern="HHmm" if="${need.hours}" />
- </tstamp>
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Core.Tasks.TStampTask.Property">
- <summary>
- The property to receive the date/time string in the given pattern.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.TStampTask.Pattern">
- <summary>The date/time pattern to be used.</summary>
- <remarks>
- <para>The following table lists the standard format characters for each standard pattern. The format characters are case-sensitive; for example, 'g' and 'G' represent slightly different patterns.</para>
- <list type="table">
- <listheader>
- <description>Format Character</description>
- <description>Description Example Format Pattern (en-US)</description>
- </listheader>
- <item><description>d</description><description>MM/dd/yyyy</description></item>
- <item><description>D</description><description>dddd, dd MMMM yyyy</description></item>
- <item><description>f</description><description>dddd, dd MMMM yyyy HH:mm</description></item>
- <item><description>F</description><description>dddd, dd MMMM yyyy HH:mm:ss</description></item>
- <item><description>g</description><description>MM/dd/yyyy HH:mm</description></item>
- <item><description>G</description><description>MM/dd/yyyy HH:mm:ss</description></item>
- <item><description>m, M</description><description>MMMM dd</description></item>
- <item><description>r, R</description><description>ddd, dd MMM yyyy HH':'mm':'ss 'GMT'</description></item>
- <item><description>s</description><description>yyyy'-'MM'-'dd'T'HH':'mm':'ss</description></item>
- <item><description>t</description><description>HH:mm</description></item>
- <item><description>T</description><description>HH:mm:ss</description></item>
- <item><description>u</description><description>yyyy'-'MM'-'dd HH':'mm':'ss'Z'</description></item>
- <item><description>U</description><description>dddd, dd MMMM yyyy HH:mm:ss</description></item>
- <item><description>y, Y</description><description>yyyy MMMM</description></item>
- </list>
- <para>The following table lists the patterns that can be combined to construct custom patterns. The patterns are case-sensitive; for example, "MM" is recognized, but "mm" is not. If the custom pattern contains white-space characters or characters enclosed in single quotation marks, the output string will also contain those characters. Characters not defined as part of a format pattern or as format characters are reproduced literally.</para>
- <list type="table">
- <listheader>
- <description>Format</description>
- <description>Pattern Description</description>
- </listheader>
- <item><description>d</description><description>The day of the month. Single-digit days will not have a leading zero.</description></item>
- <item><description>dd</description><description>The day of the month. Single-digit days will have a leading zero.</description></item>
- <item><description>ddd</description><description>The abbreviated name of the day of the week.</description></item>
- <item><description>dddd</description><description>The full name of the day of the week.</description></item>
- <item><description>M</description><description>The numeric month. Single-digit months will not have a leading zero.</description></item>
- <item><description>MM</description><description>The numeric month. Single-digit months will have a leading zero.</description></item>
- <item><description>MMM</description><description>The abbreviated name of the month.</description></item>
- <item><description>MMMM</description><description>The full name of the month.</description></item>
- <item><description>y</description><description>The year without the century. If the year without the century is less than 10, the year is displayed with no leading zero.</description></item>
- <item><description>yy</description><description>The year without the century. If the year without the century is less than 10, the year is displayed with a leading zero.</description></item>
- <item><description>yyyy</description><description>The year in four digits, including the century.</description></item>
- <item><description>gg</description><description>The period or era. This pattern is ignored if the date to be formatted does not have an associated period or era string.</description></item>
- <item><description>h</description><description>The hour in a 12-hour clock. Single-digit hours will not have a leading zero.</description></item>
- <item><description>hh</description><description>The hour in a 12-hour clock. Single-digit hours will have a leading zero.</description></item>
- <item><description>H</description><description>The hour in a 24-hour clock. Single-digit hours will not have a leading zero.</description></item>
- <item><description>HH</description><description>The hour in a 24-hour clock. Single-digit hours will have a leading zero.</description></item>
- <item><description>m</description><description>The minute. Single-digit minutes will not have a leading zero.</description></item>
- <item><description>mm</description><description>The minute. Single-digit minutes will have a leading zero.</description></item>
- <item><description>s</description><description>The second. Single-digit seconds will not have a leading zero.</description></item>
- <item><description>ss</description><description>The second. Single-digit seconds will have a leading zero.</description></item>
- <item><description>f</description><description>The fraction of a second in single-digit precision. The remaining digits are truncated.</description></item>
- <item><description>ff</description><description>The fraction of a second in double-digit precision. The remaining digits are truncated.</description></item>
- <item><description>fff</description><description>The fraction of a second in three-digit precision. The remaining digits are truncated.</description></item>
- <item><description>ffff</description><description>The fraction of a second in four-digit precision. The remaining digits are truncated.</description></item>
- <item><description>fffff</description><description>The fraction of a second in five-digit precision. The remaining digits are truncated. </description></item>
- <item><description>ffffff</description><description>The fraction of a second in six-digit precision. The remaining digits are truncated. </description></item>
- <item><description>fffffff</description><description>The fraction of a second in seven-digit precision. The remaining digits are truncated. </description></item>
- <item><description>t</description><description>The first character in the AM/PM designator.</description></item>
- <item><description>tt</description><description>The AM/PM designator. </description></item>
- <item><description>z</description><description>The time zone offset ("+" or "-" followed by the hour only). Single-digit hours will not have a leading zero. For example, Pacific Standard Time is "-8".</description></item>
- <item><description>zz</description><description>The time zone offset ("+" or "-" followed by the hour only). Single-digit hours will have a leading zero. For example, Pacific Standard Time is "-08".</description></item>
- <item><description>zzz</description><description>The full time zone offset ("+" or "-" followed by the hour and minutes). Single-digit hours and minutes will have leading zeros. For example, Pacific Standard Time is "-08:00".</description></item>
- <item><description>:</description><description>The default time separator.</description></item>
- <item><description>/</description><description>The default date separator.</description></item>
- <item><description>\ c</description><description>Pattern Where c is any character. Displays the character literally. To display the backslash character, use "\\". </description></item>
- </list>
- </remarks>
- </member>
- <member name="T:NAnt.Core.Tasks.TouchTask">
- <summary>
- Touches a file or set of files -- corresponds to the Unix touch command.
- </summary>
- <remarks>
- <para>
- If the file specified does not exist, the task will create it.
- </para>
- </remarks>
- <example>
- <para>Touch the <c>Main.cs</c> file. The current time is used.</para>
- <code>
- <![CDATA[
- <touch file="Main.cs" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Touch all executable files in the project base directory and its
- subdirectories.
- </para>
- <code>
- <![CDATA[
- <touch>
- <fileset>
- <include name="**/*.exe" />
- <include name="**/*.dll" />
- </fileset>
- </touch>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Tasks.TouchTask.InitializeTask(System.Xml.XmlNode)">
- <summary>
- Ensures the supplied attributes are valid.
- </summary>
- <param name="taskNode">Xml node used to define this task instance.</param>
- </member>
- <member name="P:NAnt.Core.Tasks.TouchTask.File">
- <summary>
- The file to touch.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.TouchTask.Millis">
- <summary>
- Specifies the new modification time of the file(s) in milliseconds
- since midnight Jan 1 1970.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.TouchTask.Datetime">
- <summary>
- Specifies the new modification time of the file in the format
- MM/DD/YYYY HH:MM:SS.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.TouchTask.TouchFileSet">
- <summary>
- Used to select files that should be touched.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.UpToDateTask">
- <summary>
- Check modification dates on groups of files.
- </summary>
- <remarks>
- If all <see cref="P:NAnt.Core.Tasks.UpToDateTask.TargetFiles"/> are same or newer than all <see cref="P:NAnt.Core.Tasks.UpToDateTask.SourceFiles"/>, the specified property is set to <see langword="true"/>, otherwise it
- is set to <see langword="false"/>.
- </remarks>
- <example>
- <para>
- Check file dates. If <c>myfile.dll</c> is same or newer than <c>myfile.cs</c>, then set <c>myfile.dll.uptodate</c> property
- to either <see langword="true"/> or <see langword="false"/>.
- </para>
- <code>
- <![CDATA[
- <uptodate property="myfile.dll.uptodate">
- <sourcefiles>
- <include name="myfile.cs" />
- </sourcefiles>
- <targetfiles>
- <include name="myfile.dll" />
- </targetfiles>
- </uptodate>
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Core.Tasks.UpToDateTask.PropertyName">
- <summary>
- Property that will be set to <see langword="true" /> or <see langword="false" /> depending on the
- result of the date check.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.UpToDateTask.SourceFiles">
- <summary>
- The <see cref="T:NAnt.Core.Types.FileSet"/> that contains list of source files.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.UpToDateTask.TargetFiles">
- <summary>
- The <see cref="T:NAnt.Core.Types.FileSet"/> that contains list of target files.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.XmlPeekTask">
- <summary>
- Extracts text from an XML file at the location specified by an XPath
- expression.
- </summary>
- <remarks>
- <para>
- If the XPath expression specifies multiple nodes the node index is used
- to determine which of the nodes' text is returned.
- </para>
- </remarks>
- <example>
- <para>
- The example provided assumes that the following XML file (App.config)
- exists in the current build directory.
- </para>
- <code>
- <![CDATA[
- <?xml version="1.0" encoding="utf-8" ?>
- <configuration xmlns="http://www.gordic.cz/shared/project-config/v_1.0.0.0">
- <appSettings>
- <add key="server" value="testhost.somecompany.com" />
- </appSettings>
- </configuration>
- ]]>
- </code>
- </example>
- <example>
- <para>
- The example will read the server value from the above
- configuration file.
- </para>
- <code>
- <![CDATA[
- <xmlpeek
- file="App.config"
- xpath="/x:configuration/x:appSettings/x:add[@key = 'server']/@value"
- property="configuration.server">
- <namespaces>
- <namespace prefix="x" uri="http://www.gordic.cz/shared/project-config/v_1.0.0.0" />
- </namespaces>
- </xmlpeek>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Tasks.XmlPeekTask.ExecuteTask">
- <summary>
- Executes the XML peek task.
- </summary>
- </member>
- <member name="M:NAnt.Core.Tasks.XmlPeekTask.LoadDocument(System.String)">
- <summary>
- Loads an XML document from a file on disk.
- </summary>
- <param name="fileName">The file name of the file to load the XML document from.</param>
- <returns>
- A <see cref="T:System.Xml.XmlDocument">document</see> containing
- the document object representing the file.
- </returns>
- </member>
- <member name="M:NAnt.Core.Tasks.XmlPeekTask.GetNodeContents(System.String,System.Xml.XmlDocument,System.Int32)">
- <summary>
- Gets the contents of the node specified by the XPath expression.
- </summary>
- <param name="xpath">The XPath expression used to determine which nodes to choose from.</param>
- <param name="document">The XML document to select the nodes from.</param>
- <param name="nodeIndex">The node index in the case where multiple nodes satisfy the expression.</param>
- <returns>
- The contents of the node specified by the XPath expression.
- </returns>
- </member>
- <member name="P:NAnt.Core.Tasks.XmlPeekTask.XmlFile">
- <summary>
- The name of the file that contains the XML document
- that is going to be peeked at.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.XmlPeekTask.NodeIndex">
- <summary>
- The index of the node that gets its text returned when the query
- returns multiple nodes.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.XmlPeekTask.Property">
- <summary>
- The property that receives the text representation of the XML inside
- the node returned from the XPath expression.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.XmlPeekTask.XPath">
- <summary>
- The XPath expression used to select which node to read.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.XmlPeekTask.Namespaces">
- <summary>
- Namespace definitions to resolve prefixes in the XPath expression.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.XmlPokeTask">
- <summary>
- Replaces text in an XML file at the location specified by an XPath
- expression.
- </summary>
- <remarks>
- <para>
- The location specified by the XPath expression must exist, it will
- not create the parent elements for you. However, provided you have
- a root element you could use a series of the tasks to build the
- XML file up if necessary.
- </para>
- </remarks>
- <example>
- <para>
- Change the <c>server</c> setting in the configuration from <c>testhost.somecompany.com</c>
- to <c>productionhost.somecompany.com</c>.
- </para>
- <para>XML file:</para>
- <code>
- <![CDATA[
- <?xml version="1.0" encoding="utf-8" ?>
- <configuration>
- <appSettings>
- <add key="server" value="testhost.somecompany.com" />
- </appSettings>
- </configuration>
- ]]>
- </code>
- <para>Build fragment:</para>
- <code>
- <![CDATA[
- <xmlpoke
- file="App.config"
- xpath="/configuration/appSettings/add[@key = 'server']/@value"
- value="productionhost.somecompany.com" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Modify the <c>noNamespaceSchemaLocation</c> in an XML file.
- </para>
- <para>XML file:</para>
- <code>
- <![CDATA[
- <?xml version="1.0" encoding="utf-8" ?>
- <Commands xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="Path Value">
- </Commands>
- ]]>
- </code>
- <para>Build fragment:</para>
- <code>
- <![CDATA[
- <xmlpoke file="test.xml" xpath="/Commands/@xsi:noNamespaceSchemaLocation" value="d:\Commands.xsd">
- <namespaces>
- <namespace prefix="xsi" uri="http://www.w3.org/2001/XMLSchema-instance" />
- </namespaces>
- </xmlpoke>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Tasks.XmlPokeTask.ExecuteTask">
- <summary>
- Executes the XML poke task.
- </summary>
- </member>
- <member name="M:NAnt.Core.Tasks.XmlPokeTask.LoadDocument(System.String)">
- <summary>
- Loads an XML document from a file on disk.
- </summary>
- <param name="fileName">
- The file name of the file to load the XML document from.
- </param>
- <returns>
- An <see cref="T:System.Xml.XmlDocument"/> containing
- the document object model representing the file.
- </returns>
- </member>
- <member name="M:NAnt.Core.Tasks.XmlPokeTask.SelectNodes(System.String,System.Xml.XmlDocument,System.Xml.XmlNamespaceManager)">
- <summary>
- Given an XML document and an expression, returns a list of nodes
- which match the expression criteria.
- </summary>
- <param name="xpath">
- The XPath expression used to select the nodes.
- </param>
- <param name="document">
- The XML document that is searched.
- </param>
- <param name="nsMgr">
- An <see cref="T:System.Xml.XmlNamespaceManager"/> to use for resolving namespaces
- for prefixes in the XPath expression.
- </param>
- <returns>
- An <see cref="T:System.Xml.XmlNodeList"/> containing references to the nodes
- that matched the XPath expression.
- </returns>
- </member>
- <member name="M:NAnt.Core.Tasks.XmlPokeTask.UpdateNodes(System.Xml.XmlNodeList,System.String)">
- <summary>
- Given a node list, replaces the XML within those nodes.
- </summary>
- <param name="nodes">
- The list of nodes to replace the contents of.
- </param>
- <param name="value">
- The text to replace the contents with.
- </param>
- </member>
- <member name="M:NAnt.Core.Tasks.XmlPokeTask.SaveDocument(System.Xml.XmlDocument,System.String)">
- <summary>
- Saves the XML document to a file.
- </summary>
- <param name="document">The XML document to be saved.</param>
- <param name="fileName">The file name to save the XML document under.</param>
- </member>
- <member name="P:NAnt.Core.Tasks.XmlPokeTask.XmlFile">
- <summary>
- The name of the file that contains the XML document that is going
- to be poked.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.XmlPokeTask.XPath">
- <summary>
- The XPath expression used to select which nodes are to be modified.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.XmlPokeTask.Value">
- <summary>
- The value that replaces the contents of the selected nodes.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.XmlPokeTask.Namespaces">
- <summary>
- Namespace definitions to resolve prefixes in the XPath expression.
- </summary>
- </member>
- <member name="T:NAnt.Core.Types.Argument">
- <summary>
- Represents a command-line argument.
- </summary>
- <example>
- <para>
- A single command-line argument containing a space character.
- </para>
- <code>
- <![CDATA[
- <arg value="-l -a" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Two separate command-line arguments.
- </para>
- <code>
- <![CDATA[
- <arg line="-l -a" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- A single command-line argument with the value <c>\dir;\dir2;\dir3</c>
- on DOS-based systems and <c>/dir:/dir2:/dir3</c> on Unix-like systems.
- </para>
- <code>
- <![CDATA[
- <arg path="/dir;/dir2:\dir3" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Types.Argument.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.Argument"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.Argument.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.Argument"/> class
- with the specified command-line argument.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.Argument.#ctor(System.IO.FileInfo)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.Argument"/> class
- with the given file.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.Argument.#ctor(NAnt.Core.Types.PathSet)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.Argument"/> class
- with the given path.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.Argument.ToString">
- <summary>
- Returns the argument as a <see cref="T:System.String"/>.
- </summary>
- <returns>
- The argument as a <see cref="T:System.String"/>.
- </returns>
- <remarks>
- File and individual path elements will be quoted if necessary.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Types.Argument.QuoteArgument(System.String)">
- <summary>
- Quotes a command line argument if it contains a single quote or a
- space.
- </summary>
- <param name="argument">The command line argument.</param>
- <returns>
- A quoted command line argument if <paramref name="argument" />
- contains a single quote or a space; otherwise,
- <paramref name="argument" />.
- </returns>
- </member>
- <member name="P:NAnt.Core.Types.Argument.Value">
- <summary>
- A single command-line argument; can contain space characters.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Argument.File">
- <summary>
- The name of a file as a single command-line argument; will be
- replaced with the absolute filename of the file.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Argument.Directory">
- <summary>
- The value for a directory-based command-line argument; will be
- replaced with the absolute path of the directory.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Argument.Path">
- <summary>
- The value for a PATH-like command-line argument; you can use
- <c>:</c> or <c>;</c> as path separators and NAnt will convert it
- to the platform's local conventions, while resolving references to
- environment variables.
- </summary>
- <remarks>
- Individual parts will be replaced with the absolute path, resolved
- relative to the project base directory.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Types.Argument.PathSet">
- <summary>
- Sets a single command-line argument and treats it like a PATH - ensures
- the right separator for the local platform is used.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Argument.Line">
- <summary>
- List of command-line arguments; will be passed to the executable
- as is.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Argument.IfDefined">
- <summary>
- Indicates if the argument should be passed to the external program.
- If <see langword="true" /> then the argument will be passed;
- otherwise, skipped. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Argument.UnlessDefined">
- <summary>
- Indicates if the argument should not be passed to the external
- program. If <see langword="false" /> then the argument will be
- passed; otherwise, skipped. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Argument.StringValue">
- <summary>
- Gets string value corresponding with the argument.
- </summary>
- </member>
- <member name="T:NAnt.Core.Types.ArgumentCollection">
- <summary>
- Contains a collection of <see cref="T:NAnt.Core.Types.Argument"/> elements.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.ArgumentCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.ArgumentCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.ArgumentCollection.#ctor(NAnt.Core.Types.ArgumentCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.ArgumentCollection"/> class
- with the specified <see cref="T:NAnt.Core.Types.ArgumentCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.ArgumentCollection.#ctor(NAnt.Core.Types.Argument[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.ArgumentCollection"/> class
- with the specified array of <see cref="T:NAnt.Core.Types.Argument"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.ArgumentCollection.Add(NAnt.Core.Types.Argument)">
- <summary>
- Adds a <see cref="T:NAnt.Core.Types.Argument"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.Argument"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.Core.Types.ArgumentCollection.AddRange(NAnt.Core.Types.Argument[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Types.Argument"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.Core.Types.Argument"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Types.ArgumentCollection.AddRange(NAnt.Core.Types.ArgumentCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Types.ArgumentCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.Core.Types.ArgumentCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Types.ArgumentCollection.Contains(NAnt.Core.Types.Argument)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.Types.Argument"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.Argument"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.ArgumentCollection.Contains(System.String)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.Types.Argument"/> with the specified
- value is in the collection.
- </summary>
- <param name="value">The argument value to locate in the collection.</param>
- <returns>
- <see langword="true"/> if a <see cref="T:NAnt.Core.Types.Argument"/> with value
- <paramref name="value"/> is found in the collection; otherwise,
- <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.ArgumentCollection.CopyTo(NAnt.Core.Types.Argument[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.Core.Types.ArgumentCollection.IndexOf(NAnt.Core.Types.Argument)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.Core.Types.Argument"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.Argument"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.Core.Types.Argument"/>. If the <see cref="T:NAnt.Core.Types.Argument"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.ArgumentCollection.Insert(System.Int32,NAnt.Core.Types.Argument)">
- <summary>
- Inserts a <see cref="T:NAnt.Core.Types.Argument"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.Core.Types.Argument"/> to insert.</param>
- </member>
- <member name="M:NAnt.Core.Types.ArgumentCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.Core.Types.ArgumentEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.ArgumentCollection.Remove(NAnt.Core.Types.Argument)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.Argument"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.Core.Types.ArgumentCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="P:NAnt.Core.Types.ArgumentCollection.Item(System.String)">
- <summary>
- Gets the <see cref="T:NAnt.Core.Types.Argument"/> with the specified value.
- </summary>
- <param name="value">The value of the <see cref="T:NAnt.Core.Types.Argument"/> to get.</param>
- </member>
- <member name="T:NAnt.Core.Types.ArgumentEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.Core.Types.Argument"/> elements of a <see cref="T:NAnt.Core.Types.ArgumentCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.ArgumentEnumerator.#ctor(NAnt.Core.Types.ArgumentCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.ArgumentEnumerator"/> class
- with the specified <see cref="T:NAnt.Core.Types.ArgumentCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.Core.Types.ArgumentEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.ArgumentEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.ArgumentEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.Core.Types.Credential">
- <summary>
- Provides credentials for password-based authentication schemes.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.Credential.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.Credential"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.Credential.GetCredential">
- <summary>
- Returns a <see cref="T:System.Net.NetworkCredential"/> instance representing
- the current <see cref="T:NAnt.Core.Types.Credential"/>.
- </summary>
- <returns>
- A <see cref="T:System.Net.NetworkCredential"/> instance representing the current
- <see cref="T:NAnt.Core.Types.Credential"/>, or <see langword="null"/> if the
- credentials should not be used to provide authentication information
- to the external resource.
- </returns>
- </member>
- <member name="P:NAnt.Core.Types.Credential.Domain">
- <summary>
- The domain or computer name that verifies the credentials.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Credential.Password">
- <summary>
- The password for the user name associated with the credentials.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Credential.UserName">
- <summary>
- The user name associated with the credentials.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Credential.IfDefined">
- <summary>
- Indicates if the credentials should be used to provide authentication
- information to the external resource. If <see langword="true" /> then
- the credentials will be passed; otherwise, not. The default is
- <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Credential.UnlessDefined">
- <summary>
- Indicates if the credentials should not be used to provide authentication
- information to the external resource. If <see langword="false" /> then the
- credentials will be passed; otherwise, not. The default is
- <see langword="false" />.
- </summary>
- </member>
- <member name="T:NAnt.Core.Types.DirSet">
- <summary>
- A specialized <see cref="T:NAnt.Core.Types.FileSet"/> used for specifying a set of
- directories.
- </summary>
- <remarks>
- Hint for supporting tasks that the included directories instead of
- files should be used.
- </remarks>
- </member>
- <member name="T:NAnt.Core.Types.FileSet">
- <summary>
- Filesets are groups of files. These files can be found in a directory
- tree starting in a base directory and are matched by patterns taken
- from a number of patterns. Filesets can appear inside tasks that support
- this feature or at the project level, i.e., as children of <c><project></c>.
- </summary>
- <remarks>
- <h3>Patterns</h3>
- <para>
- As described earlier, patterns are used for the inclusion and exclusion.
- These patterns look very much like the patterns used in DOS and UNIX:
- </para>
- <list type="bullet">
- <item>
- <description>
- <para>'<c>*</c>' matches zero or more characters</para>
- <para>For example:</para>
- <para>
- <c>*.cs</c> matches <c>.cs</c>, <c>x.cs</c> and <c>FooBar.cs</c>,
- but not <c>FooBar.xml</c> (does not end with <c>.cs</c>).
- </para>
- </description>
- </item>
- <item>
- <description>
- <para>'<c>?</c>' matches one character</para>
- <para>For example:</para>
- <para>
- <c>?.cs</c> matches <c>x.cs</c>, <c>A.cs</c>, but not
- <c>.cs</c> or <c>xyz.cs</c> (both don't have one character
- before <c>.cs</c>).
- </para>
- </description>
- </item>
- </list>
- <para>
- Combinations of <c>*</c>'s and <c>?</c>'s are allowed.
- </para>
- <para>
- Matching is done per-directory. This means that first the first directory
- in the pattern is matched against the first directory in the path to match.
- Then the second directory is matched, and so on. For example, when we have
- the pattern <c>/?abc/*/*.cs</c> and the path <c>/xabc/foobar/test.cs</c>,
- the first <c>?abc</c> is matched with <c>xabc</c>, then <c>*</c> is matched
- with <c>foobar</c>, and finally <c>*.cs</c> is matched with <c>test.cs</c>.
- They all match, so the path matches the pattern.
- </para>
- <para>
- To make things a bit more flexible, we added one extra feature, which makes
- it possible to match multiple directory levels. This can be used to match a
- complete directory tree, or a file anywhere in the directory tree. To do this,
- <c>**</c> must be used as the name of a directory. When <c>**</c> is used as
- the name of a directory in the pattern, it matches zero or more directories.
- For example: <c>/test/**</c> matches all files/directories under <c>/test/</c>,
- such as <c>/test/x.cs</c>, or <c>/test/foo/bar/xyz.html</c>, but not <c>/xyz.xml</c>.
- </para>
- <para>
- There is one "shorthand" - if a pattern ends with <c>/</c> or <c>\</c>, then
- <c>**</c> is appended. For example, <c>mypackage/test/</c> is interpreted as
- if it were <c>mypackage/test/**</c>.
- </para>
- <h3>Default Excludes</h3>
- <para>
- There are a set of definitions that are excluded by default from all
- tasks that use filesets. They are:
- </para>
- <list type="bullet">
- <item>
- <description>
- **/*~
- </description>
- </item>
- <item>
- <description>
- **/#*#
- </description>
- </item>
- <item>
- <description>
- **/.#*
- </description>
- </item>
- <item>
- <description>
- **/%*%
- </description>
- </item>
- <item>
- <description>
- **/CVS
- </description>
- </item>
- <item>
- <description>
- **/CVS/**
- </description>
- </item>
- <item>
- <description>
- **/.cvsignore
- </description>
- </item>
- <item>
- <description>
- **/.svn
- </description>
- </item>
- <item>
- <description>
- **/.svn/**
- </description>
- </item>
- <item>
- <description>
- **/_svn
- </description>
- </item>
- <item>
- <description>
- **/_svn/**
- </description>
- </item>
- <item>
- <description>
- **/SCCS
- </description>
- </item>
- <item>
- <description>
- **/SCCS/**
- </description>
- </item>
- <item>
- <description>
- **/vssver.scc
- </description>
- </item>
- <item>
- <description>
- **/_vti_cnf/**
- </description>
- </item>
- </list>
- <para>
- If you do not want these default excludes applied, you may disable them
- by setting <see cref="P:NAnt.Core.Types.FileSet.DefaultExcludes"/> to <see langword="false"/>.
- </para>
- </remarks>
- <example>
- <list type="table">
- <listheader>
- <term>Pattern</term>
- <description>Match</description>
- </listheader>
- <item>
- <term><c>**/CVS/*</c></term>
- <description>
- <para>
- Matches all files in <c>CVS</c> directories that can be
- located anywhere in the directory tree.
- </para>
- <para>Matches:</para>
- <list type="bullet">
- <item>
- <description>CVS/Repository</description>
- </item>
- <item>
- <description>org/apache/CVS/Entries</description>
- </item>
- <item>
- <description>org/apache/jakarta/tools/ant/CVS/Entries</description>
- </item>
- </list>
- <para>But not:</para>
- <list type="bullet">
- <item>
- <description>org/apache/CVS/foo/bar/Entries (<c>foo/bar/</c> part does not match)</description>
- </item>
- </list>
- </description>
- </item>
- <item>
- <term><c>org/apache/jakarta/**</c></term>
- <description>
- <para>
- Matches all files in the <c>org/apache/jakarta</c> directory
- tree.
- </para>
- <para>Matches:</para>
- <list type="bullet">
- <item>
- <description>org/apache/jakarta/tools/ant/docs/index.html</description>
- </item>
- <item>
- <description>org/apache/jakarta/test.xml</description>
- </item>
- </list>
- <para>But not:</para>
- <list type="bullet">
- <item>
- <description>org/apache/xyz.java (<c>jakarta/</c> part is missing)</description>
- </item>
- </list>
- </description>
- </item>
- <item>
- <term><c>org/apache/**/CVS/*</c></term>
- <description>
- <para>
- Matches all files in <c>CVS</c> directories that are located
- anywhere in the directory tree under <c>org/apache</c>.
- </para>
- <para>Matches:</para>
- <list type="bullet">
- <item>
- <description>org/apache/CVS/Entries</description>
- </item>
- <item>
- <description>org/apache/jakarta/tools/ant/CVS/Entries</description>
- </item>
- </list>
- <para>But not:</para>
- <list type="bullet">
- <item>
- <description>org/apache/CVS/foo/bar/Entries (<c>foo/bar/</c> part does not match)</description>
- </item>
- </list>
- </description>
- </item>
- <item>
- <term><c>**/test/**</c></term>
- <description>
- <para>
- Matches all files that have a <c>test</c> element in their
- path, including <c>test</c> as a filename.
- </para>
- </description>
- </item>
- </list>
- </example>
- </member>
- <member name="M:NAnt.Core.Types.FileSet.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.FileSet"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.FileSet.#ctor(NAnt.Core.Types.FileSet)">
- <summary>
- copy constructor
- </summary>
- <param name="fs"></param>
- </member>
- <member name="M:NAnt.Core.Types.FileSet.Clone">
- <summary>
- Creates a shallow copy of the <see cref="T:NAnt.Core.Types.FileSet"/>.
- </summary>
- <returns>
- A shallow copy of the <see cref="T:NAnt.Core.Types.FileSet"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.FileSet.CopyTo(NAnt.Core.Types.FileSet)">
- <summary>
- Copies all instance data of the <see cref="T:NAnt.Core.Types.FileSet"/> to a given
- <see cref="T:NAnt.Core.Types.FileSet"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.FileSet.FindMoreRecentLastWriteTime(System.String,System.DateTime)">
- <summary>
- Determines if a file has a more recent last write time than the
- given time, or no longer exists.
- </summary>
- <param name="fileName">A file to check the last write time against.</param>
- <param name="targetLastWriteTime">The datetime to compare against.</param>
- <returns>
- The name of the file that has a last write time greater than
- <paramref name="targetLastWriteTime" /> or that no longer exists;
- otherwise, <see langword="null" />.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.FileSet.FindMoreRecentLastWriteTime(System.Collections.Specialized.StringCollection,System.DateTime)">
- <summary>
- Determines if one of the given files has a more recent last write
- time than the given time. If one of the given files no longer exists,
- the target will be considered out-of-date.
- </summary>
- <param name="fileNames">A collection of filenames to check the last write time against.</param>
- <param name="targetLastWriteTime">The datetime to compare against.</param>
- <returns>
- The name of the first file that has a last write time greater than
- <paramref name="targetLastWriteTime" />; otherwise, null.
- </returns>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.FailOnEmpty">
- <summary>
- When set to <see langword="true"/>, causes the fileset element to
- throw a <see cref="T:NAnt.Core.ValidationException"/> when no files match the
- includes and excludes criteria. The default is <see langword="false"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.DefaultExcludes">
- <summary>
- Indicates whether default excludes should be used or not.
- The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.BaseDirectory">
- <summary>
- The base of the directory of this fileset. The default is the project
- base directory.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.Includes">
- <summary>
- Gets the collection of include patterns.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.Excludes">
- <summary>
- Gets the collection of exclude patterns.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.AsIs">
- <summary>
- Gets the collection of files that will be added to the
- <see cref="T:NAnt.Core.Types.FileSet"/> without pattern matching or checking if the
- file exists.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.FileNames">
- <summary>
- Gets the collection of file names that match the fileset.
- </summary>
- <value>
- A collection that contains the file names that match the
- <see cref="T:NAnt.Core.Types.FileSet"/>.
- </value>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.DirectoryNames">
- <summary>
- Gets the collection of directory names that match the fileset.
- </summary>
- <value>
- A collection that contains the directory names that match the
- <see cref="T:NAnt.Core.Types.FileSet"/>.
- </value>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.ScannedDirectories">
- <summary>
- Gets the collection of directory names that were scanned for files.
- </summary>
- <value>
- A collection that contains the directory names that were scanned for
- files.
- </value>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.SetIncludes">
- <summary>
- The items to include in the fileset.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.IncludeElements">
- <summary>
- The items to include in the fileset.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.SetExcludes">
- <summary>
- The items to exclude from the fileset.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.ExcludeElements">
- <summary>
- The items to exclude from the fileset.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.SetIncludesList">
- <summary>
- The files from which a list of patterns or files to include should
- be obtained.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.IncludesFiles">
- <summary>
- The files from which a list of patterns or files to include should
- be obtained.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.ExcludesFiles">
- <summary>
- The files from which a list of patterns or files to exclude should
- be obtained.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.MostRecentLastWriteTimeFile">
- <summary>
- Determines the most recently modified file in the fileset (by LastWriteTime of the <see cref="T:System.IO.FileInfo"/>).
- </summary>
- <returns>
- The <see cref="T:System.IO.FileInfo"/> of the file that has the newest (closest to present) last write time.
- </returns>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.Exclude.Pattern">
- <summary>
- The pattern or file name to exclude.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.Exclude.IfDefined">
- <summary>
- If <see langword="true" /> then the pattern will be excluded;
- otherwise, skipped. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.Exclude.UnlessDefined">
- <summary>
- Opposite of <see cref="P:NAnt.Core.Types.FileSet.Exclude.IfDefined"/>. If <see langword="false"/>
- then the pattern will be excluded; otherwise, skipped. The default
- is <see langword="false"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.Include.AsIs">
- <summary>
- If <see langword="true"/> then the file name will be added to
- the <see cref="T:NAnt.Core.Types.FileSet"/> without pattern matching or checking
- if the file exists. The default is <see langword="false"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.Include.FromPath">
- <summary>
- If <see langword="true" /> then the file will be searched for
- on the path. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.Include.Pattern">
- <summary>
- The pattern or file name to include.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.Include.IfDefined">
- <summary>
- If <see langword="true" /> then the pattern will be included;
- otherwise, skipped. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.Include.UnlessDefined">
- <summary>
- Opposite of <see cref="P:NAnt.Core.Types.FileSet.Include.IfDefined"/>. If <see langword="false"/>
- then the pattern will be included; otherwise, skipped. The default
- is <see langword="false"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.ExcludesFile.Patterns">
- <summary>
- Gets the list of patterns in <see cref="P:NAnt.Core.Types.FileSet.ExcludesFile.PatternFile"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.ExcludesFile.IfDefined">
- <summary>
- If <see langword="true" /> then the patterns will be excluded;
- otherwise, skipped. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.ExcludesFile.UnlessDefined">
- <summary>
- Opposite of <see cref="P:NAnt.Core.Types.FileSet.ExcludesFile.IfDefined"/>. If <see langword="false"/>
- then the patterns will be excluded; otherwise, skipped. The default
- is <see langword="false"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.ExcludesFile.PatternFile">
- <summary>
- The name of a file; each line of this file is taken to be a
- pattern.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.IncludesFile.AsIs">
- <summary>
- If <see langword="true"/> then the patterns in the include file
- will be added to the <see cref="T:NAnt.Core.Types.FileSet"/> without pattern
- matching or checking if the file exists. The default is
- <see langword="false"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.IncludesFile.FromPath">
- <summary>
- If <see langword="true" /> then the patterns in the include file
- will be searched for on the path. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.IncludesFile.IfDefined">
- <summary>
- If <see langword="true" /> then the patterns will be included;
- otherwise, skipped. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.IncludesFile.UnlessDefined">
- <summary>
- Opposite of <see cref="P:NAnt.Core.Types.FileSet.IncludesFile.IfDefined"/>. If <see langword="false"/>
- then the patterns will be included; otherwise, skipped. The default
- is <see langword="false"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.DirSet.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.DirSet"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.DirSet.#ctor(NAnt.Core.Types.FileSet)">
- <summary>
- Copy constructor for <see cref="T:NAnt.Core.Types.FileSet"/>. Required in order to
- assign references of <see cref="T:NAnt.Core.Types.FileSet"/> type where
- <see cref="T:NAnt.Core.Types.DirSet"/> is used.
- </summary>
- <param name="fs">A <see cref="T:NAnt.Core.Types.FileSet"/> instance to create a <see cref="T:NAnt.Core.Types.DirSet"/> from.</param>
- </member>
- <member name="T:NAnt.Core.Types.EnvironmentVariable">
- <summary>
- Represents an environment variable.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.EnvironmentVariable.#ctor(System.String,System.String)">
- <summary>
- Initializes a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> instance with the
- specified name and value.
- </summary>
- <param name="name">The name of the environment variable.</param>
- <param name="value">The value of the environment variable.</param>
- </member>
- <member name="M:NAnt.Core.Types.EnvironmentVariable.#ctor">
- <summary>
- Initializes a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> instance.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.EnvironmentVariable.VariableName">
- <summary>
- The name of the environment variable.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.EnvironmentVariable.LiteralValue">
- <summary>
- The literal value for the environment variable.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.EnvironmentVariable.File">
- <summary>
- The value for a file-based environment variable. NAnt will convert
- it to an absolute filename.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.EnvironmentVariable.Directory">
- <summary>
- The value for a directory-based environment variable. NAnt will
- convert it to an absolute path.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.EnvironmentVariable.Path">
- <summary>
- The value for a PATH like environment variable. You can use
- <c>:</c> or <c>;</c> as path separators and NAnt will convert it to
- the platform's local conventions.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.EnvironmentVariable.PathSet">
- <summary>
- Sets a single environment variable and treats it like a PATH -
- ensures the right separator for the local platform is used.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.EnvironmentVariable.Value">
- <summary>
- Gets the value of the environment variable.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.EnvironmentVariable.IfDefined">
- <summary>
- Indicates if the environment variable should be passed to the
- external program. If <see langword="true" /> then the environment
- variable will be passed; otherwise, skipped. The default is
- <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.EnvironmentVariable.UnlessDefined">
- <summary>
- Indicates if the environment variable should not be passed to the
- external program. If <see langword="false" /> then the environment
- variable will be passed; otherwise, skipped. The default is
- <see langword="false" />.
- </summary>
- </member>
- <member name="T:NAnt.Core.Types.EnvironmentSet">
- <summary>
- A set of environment variables.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.EnvironmentSet.Options">
- <summary>
- Environment variable to pass to a program.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.EnvironmentSet.EnvironmentVariables">
- <summary>
- Environment variable to pass to a program.
- </summary>
- </member>
- <member name="T:NAnt.Core.Types.EnvironmentVariableCollection">
- <summary>
- Contains a collection of <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> elements.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.#ctor(NAnt.Core.Types.EnvironmentVariableCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/> class
- with the specified <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.#ctor(NAnt.Core.Types.EnvironmentVariable[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/> class
- with the specified array of <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.Add(NAnt.Core.Types.EnvironmentVariable)">
- <summary>
- Adds a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.AddRange(NAnt.Core.Types.EnvironmentVariable[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.AddRange(NAnt.Core.Types.EnvironmentVariableCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.Contains(NAnt.Core.Types.EnvironmentVariable)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.Contains(System.String)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> with the specified
- value is in the collection.
- </summary>
- <param name="value">The argument value to locate in the collection.</param>
- <returns>
- <see langword="true"/> if a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> with value
- <paramref name="value"/> is found in the collection; otherwise,
- <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.CopyTo(NAnt.Core.Types.EnvironmentVariable[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.IndexOf(NAnt.Core.Types.EnvironmentVariable)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.Core.Types.EnvironmentVariable"/>. If the <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.Insert(System.Int32,NAnt.Core.Types.EnvironmentVariable)">
- <summary>
- Inserts a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> to insert.</param>
- </member>
- <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.Core.Types.EnvironmentVariableEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.Remove(NAnt.Core.Types.EnvironmentVariable)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.Core.Types.EnvironmentVariableCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="P:NAnt.Core.Types.EnvironmentVariableCollection.Item(System.String)">
- <summary>
- Gets the <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> with the specified name.
- </summary>
- <param name="name">The name of the <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> to get.</param>
- </member>
- <member name="T:NAnt.Core.Types.EnvironmentVariableEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> elements of a <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.EnvironmentVariableEnumerator.#ctor(NAnt.Core.Types.EnvironmentVariableCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.EnvironmentVariableEnumerator"/> class
- with the specified <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.Core.Types.EnvironmentVariableEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.EnvironmentVariableEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.EnvironmentVariableEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="P:NAnt.Core.Types.Formatter.Property">
- <summary>
- The name of the NAnt property to set.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Formatter.Pattern">
- <summary>
- The string pattern to use to format the property.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Formatter.IfDefined">
- <summary>
- Indicates if the formatter should be used to format the timestamp.
- If <see langword="true" /> then the formatter will be used;
- otherwise, skipped. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Formatter.UnlessDefined">
- <summary>
- Indicates if the formatter should be not used to format the
- timestamp. If <see langword="false" /> then the formatter will be
- used; otherwise, skipped. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="T:NAnt.Core.Types.FormatterCollection">
- <summary>
- Contains a collection of <see cref="T:NAnt.Core.Types.Formatter"/> elements.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.FormatterCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.FormatterCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.FormatterCollection.#ctor(NAnt.Core.Types.FormatterCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.FormatterCollection"/> class
- with the specified <see cref="T:NAnt.Core.Types.FormatterCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.FormatterCollection.#ctor(NAnt.Core.Types.Formatter[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.FormatterCollection"/> class
- with the specified array of <see cref="T:NAnt.Core.Types.Formatter"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.FormatterCollection.Add(NAnt.Core.Types.Formatter)">
- <summary>
- Adds a <see cref="T:NAnt.Core.Types.Formatter"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.Formatter"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.Core.Types.FormatterCollection.AddRange(NAnt.Core.Types.Formatter[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Types.Formatter"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.Core.Types.Formatter"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Types.FormatterCollection.AddRange(NAnt.Core.Types.FormatterCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Types.FormatterCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.Core.Types.FormatterCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Types.FormatterCollection.Contains(NAnt.Core.Types.Formatter)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.Types.Formatter"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.Formatter"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.FormatterCollection.CopyTo(NAnt.Core.Types.Formatter[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.Core.Types.FormatterCollection.IndexOf(NAnt.Core.Types.Formatter)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.Core.Types.Formatter"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.Formatter"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.Core.Types.Formatter"/>. If the <see cref="T:NAnt.Core.Types.Formatter"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.FormatterCollection.Insert(System.Int32,NAnt.Core.Types.Formatter)">
- <summary>
- Inserts a <see cref="T:NAnt.Core.Types.Formatter"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.Core.Types.Formatter"/> to insert.</param>
- </member>
- <member name="M:NAnt.Core.Types.FormatterCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.Core.Types.FormatterEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.FormatterCollection.Remove(NAnt.Core.Types.Formatter)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.Formatter"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.Core.Types.FormatterCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="T:NAnt.Core.Types.FormatterEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.Core.Types.Formatter"/> elements of a <see cref="T:NAnt.Core.Types.FormatterCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.FormatterEnumerator.#ctor(NAnt.Core.Types.FormatterCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.FormatterEnumerator"/> class
- with the specified <see cref="T:NAnt.Core.Types.FormatterCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.Core.Types.FormatterEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.FormatterEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FormatterEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.Core.Types.Option">
- <summary>
- Represents an option.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.Option.#ctor(System.String,System.String)">
- <summary>
- name, value constructor
- </summary>
- <param name="name"></param>
- <param name="value"></param>
- </member>
- <member name="M:NAnt.Core.Types.Option.#ctor">
- <summary>
- Default constructor
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Option.OptionName">
- <summary>
- Name of the option.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Option.Value">
- <summary>
- Value of the option. The default is <see langword="null" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Option.IfDefined">
- <summary>
- Indicates if the option should be passed to the task.
- If <see langword="true" /> then the option will be passed;
- otherwise, skipped. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Option.UnlessDefined">
- <summary>
- Indicates if the option should not be passed to the task.
- If <see langword="false" /> then the option will be passed;
- otherwise, skipped. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="T:NAnt.Core.Types.OptionCollection">
- <summary>
- Contains a collection of <see cref="T:NAnt.Core.Types.Option"/> elements.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.OptionCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.OptionCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.OptionCollection.#ctor(NAnt.Core.Types.OptionCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.OptionCollection"/> class
- with the specified <see cref="T:NAnt.Core.Types.OptionCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.OptionCollection.#ctor(NAnt.Core.Types.Option[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.OptionCollection"/> class
- with the specified array of <see cref="T:NAnt.Core.Types.Option"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.OptionCollection.Add(NAnt.Core.Types.Option)">
- <summary>
- Adds a <see cref="T:NAnt.Core.Types.Option"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.Option"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.Core.Types.OptionCollection.AddRange(NAnt.Core.Types.Option[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Types.Option"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.Core.Types.Option"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Types.OptionCollection.AddRange(NAnt.Core.Types.OptionCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Types.OptionCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.Core.Types.OptionCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Types.OptionCollection.Contains(NAnt.Core.Types.Option)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.Types.Option"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.Option"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.OptionCollection.Contains(System.String)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.Types.Option"/> for the specified
- task is in the collection.
- </summary>
- <param name="taskName">The name of task for which the <see cref="T:NAnt.Core.Types.Option"/> should be located in the collection.</param>
- <returns>
- <see langword="true"/> if a <see cref="T:NAnt.Core.Types.Option"/> for the specified
- task is found in the collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.OptionCollection.CopyTo(NAnt.Core.Types.Option[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.Core.Types.OptionCollection.IndexOf(NAnt.Core.Types.Option)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.Core.Types.Option"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.Option"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.Core.Types.Option"/>. If the <see cref="T:NAnt.Core.Types.Option"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.OptionCollection.Insert(System.Int32,NAnt.Core.Types.Option)">
- <summary>
- Inserts a <see cref="T:NAnt.Core.Types.Option"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.Core.Types.Option"/> to insert.</param>
- </member>
- <member name="M:NAnt.Core.Types.OptionCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.Core.Types.OptionEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.OptionCollection.Remove(NAnt.Core.Types.Option)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.Option"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.Core.Types.OptionCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="P:NAnt.Core.Types.OptionCollection.Item(System.String)">
- <summary>
- Gets the <see cref="T:NAnt.Core.Types.Option"/> with the specified name.
- </summary>
- <param name="name">The name of the option that should be located in the collection.</param>
- </member>
- <member name="T:NAnt.Core.Types.OptionEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.Core.Types.Option"/> elements of a <see cref="T:NAnt.Core.Types.OptionCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.OptionEnumerator.#ctor(NAnt.Core.Types.OptionCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.OptionEnumerator"/> class
- with the specified <see cref="T:NAnt.Core.Types.OptionCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.Core.Types.OptionEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.OptionEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.OptionEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.Core.Types.PathElement">
- <summary>
- Represents a nested path element.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.PathElement.File">
- <summary>
- The name of a file to add to the path. Will be replaced with
- the absolute path of the file.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.PathElement.Directory">
- <summary>
- The name of a directory to add to the path. Will be replaced with
- the absolute path of the directory.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.PathElement.Path">
- <summary>
- A string that will be treated as a path-like string. You can use
- <c>:</c> or <c>;</c> as path separators and NAnt will convert it
- to the platform's local conventions, while resolving references
- to environment variables.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.PathElement.IfDefined">
- <summary>
- If <see langword="true" /> then the entry will be added to the
- path; otherwise, skipped. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.PathElement.UnlessDefined">
- <summary>
- Opposite of <see cref="P:NAnt.Core.Types.PathElement.IfDefined"/>. If <see langword="false"/>
- then the entry will be added to the path; otherwise, skipped.
- The default is <see langword="false"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.PathElement.Parts">
- <summary>
- Gets the parts of a path represented by this element.
- </summary>
- <value>
- A <see cref="T:System.Collections.Specialized.StringCollection"/> containing the parts of a path
- represented by this element.
- </value>
- </member>
- <member name="T:NAnt.Core.Types.PathSet">
- <summary>
- <para>
- Paths are groups of files and/or directories that need to be passed as a single
- unit. The order in which parts of the path are specified in the build file is
- retained, and duplicate parts are automatically suppressed.
- </para>
- </summary>
- <example>
- <para>
- Define a global <c><path></c> that can be referenced by other
- tasks or types.
- </para>
- <code>
- <![CDATA[
- <path id="includes-path">
- <pathelement path="%INCLUDE%" />
- <pathelement dir="${build.dir}/include" />
- </path>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Types.PathSet.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.PathSet"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.PathSet.#ctor(NAnt.Core.Project,System.String)">
- <summary>
- Invoked by <see cref="T:NAnt.Core.Element.AttributeConfigurator"/> for build
- attributes with an underlying <see cref="T:NAnt.Core.Types.PathSet"/> type.
- </summary>
- <param name="project">The <see cref="T:NAnt.Core.Project"/> to be used to resolve relative paths.</param>
- <param name="path">The string representing a path.</param>
- </member>
- <member name="M:NAnt.Core.Types.PathSet.ToString">
- <summary>
- Returns a textual representation of the path, which can be used as
- PATH environment variable definition.
- </summary>
- <returns>
- A textual representation of the path.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.PathSet.AddPath(NAnt.Core.Types.PathSet)">
- <summary>
- Defines a set of path elements to add to the current path.
- </summary>
- <param name="path">The <see cref="T:NAnt.Core.Types.PathSet"/> to add.</param>
- </member>
- <member name="M:NAnt.Core.Types.PathSet.AddPathElement(NAnt.Core.Types.PathElement)">
- <summary>
- Defines a path element to add to the current path.
- </summary>
- <param name="pathElement">The <see cref="T:NAnt.Core.Types.PathElement"/> to add.</param>
- </member>
- <member name="M:NAnt.Core.Types.PathSet.GetElements">
- <summary>
- Returns all path elements defined by this path object.
- </summary>
- <returns>
- A list of path elements.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.PathSet.TranslatePath(NAnt.Core.Project,System.String)">
- <summary>
- Splits a PATH (with ; or : as separators) into its parts, while
- resolving references to environment variables.
- </summary>
- <param name="project">The <see cref="T:NAnt.Core.Project"/> to be used to resolve relative paths.</param>
- <param name="source">The path to translate.</param>
- <returns>
- A PATH split up its parts, with references to environment variables
- resolved and duplicate entries removed.
- </returns>
- </member>
- <member name="T:NAnt.Core.Types.Proxy">
- <summary>
- Contains HTTP proxy settings used to process requests to Internet
- resources.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.Proxy.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.Proxy"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.Proxy.GetWebProxy">
- <summary>
- Gets a <see cref="T:System.Net.WebProxy"/> instance representing the current
- <see cref="T:NAnt.Core.Types.Proxy"/>.
- </summary>
- <returns>
- A <see cref="T:System.Net.WebProxy"/> instance representing the current
- <see cref="T:NAnt.Core.Types.Proxy"/>, or <see langword="GlobalProxySelection.Select"/>
- if this proxy should not be used to connect to the external resource.
- </returns>
- </member>
- <member name="P:NAnt.Core.Types.Proxy.Host">
- <summary>
- The name of the proxy host.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Proxy.Port">
- <summary>
- The port number on <see cref="P:NAnt.Core.Types.Proxy.Host"/> to use.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Proxy.BypassOnLocal">
- <summary>
- Specifies whether to bypass the proxy server for local addresses.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Proxy.Credentials">
- <summary>
- The credentials to submit to the proxy server for authentication.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Proxy.IfDefined">
- <summary>
- Indicates if the proxy should be used to connect to the external
- resource. If <see langword="true" /> then the proxy will be used;
- otherwise, not. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Proxy.UnlessDefined">
- <summary>
- Indicates if the proxy should not be used to connect to the external
- resource. If <see langword="false" /> then the proxy will be used;
- otherwise, not. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="T:NAnt.Core.Types.RawXml">
- <summary>
- Represents an element of which the XML is processed by its parent task
- or type.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.RawXml.Xml">
- <summary>
- Gets the XML that this element represents.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.RawXml.CustomXmlProcessing">
- <summary>
- Gets a value indicating whether the element is performing additional
- processing using the <see cref="T:System.Xml.XmlNode"/> that was use to
- initialize the element.
- </summary>
- <value>
- <see langword="true"/>, as the XML that represents this build
- element is processed by the containing task or type.
- </value>
- </member>
- <member name="T:NAnt.Core.Types.Token">
- <summary>
- ReplaceTokens filter token.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Token.Key">
- <summary>
- Token to be replaced.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Token.Value">
- <summary>
- New value of token.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Token.IfDefined">
- <summary>
- Indicates if the token should be used to replace values.
- If <see langword="true" /> then the token will be used;
- otherwise, not. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Token.UnlessDefined">
- <summary>
- Indicates if the token should not be used to replace values.
- If <see langword="false" /> then the token will be used;
- otherwise, not. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="T:NAnt.Core.Types.XmlNamespace">
- <summary>
- Represents an XML namespace.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.XmlNamespace.Prefix">
- <summary>
- The prefix to associate with the namespace.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.XmlNamespace.Uri">
- <summary>
- The associated XML namespace URI.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.XmlNamespace.IfDefined">
- <summary>
- Indicates if the namespace should be added to the <see cref="T:System.Xml.XmlNamespaceManager"/>.
- If <see langword="true"/> then the namespace will be added;
- otherwise, skipped. The default is <see langword="true"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.XmlNamespace.UnlessDefined">
- <summary>
- Indicates if the namespace should not be added to the <see cref="T:System.Xml.XmlNamespaceManager"/>.
- list. If <see langword="false"/> then the parameter will be
- added; otherwise, skipped. The default is <see langword="false"/>.
- </summary>
- </member>
- <member name="T:NAnt.Core.Types.XmlNamespaceCollection">
- <summary>
- Contains a collection of <see cref="T:NAnt.Core.Types.XmlNamespace"/> elements.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.XmlNamespaceCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.XmlNamespaceCollection.#ctor(NAnt.Core.Types.XmlNamespaceCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/> class
- with the specified <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.XmlNamespaceCollection.#ctor(NAnt.Core.Types.XmlNamespace[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/> class
- with the specified array of <see cref="T:NAnt.Core.Types.XmlNamespace"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.XmlNamespaceCollection.Add(NAnt.Core.Types.XmlNamespace)">
- <summary>
- Adds a <see cref="T:NAnt.Core.Types.XmlNamespace"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.XmlNamespace"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.Core.Types.XmlNamespaceCollection.AddRange(NAnt.Core.Types.XmlNamespace[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Types.XmlNamespace"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.Core.Types.XmlNamespace"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Types.XmlNamespaceCollection.AddRange(NAnt.Core.Types.XmlNamespaceCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Types.XmlNamespaceCollection.Contains(NAnt.Core.Types.XmlNamespace)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.Types.XmlNamespace"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.XmlNamespace"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.XmlNamespaceCollection.Contains(System.String)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.Types.XmlNamespace"/> with the specified
- value is in the collection.
- </summary>
- <param name="value">The argument value to locate in the collection.</param>
- <returns>
- <see langword="true"/> if a <see cref="T:NAnt.Core.Types.XmlNamespace"/> with
- value <paramref name="value"/> is found in the collection; otherwise,
- <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.XmlNamespaceCollection.CopyTo(NAnt.Core.Types.XmlNamespace[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.Core.Types.XmlNamespaceCollection.IndexOf(NAnt.Core.Types.XmlNamespace)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.Core.Types.XmlNamespace"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.XmlNamespace"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.Core.Types.XmlNamespace"/>. If the <see cref="T:NAnt.Core.Types.XmlNamespace"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.XmlNamespaceCollection.Insert(System.Int32,NAnt.Core.Types.XmlNamespace)">
- <summary>
- Inserts a <see cref="T:NAnt.Core.Types.XmlNamespace"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.Core.Types.XmlNamespace"/> to insert.</param>
- </member>
- <member name="M:NAnt.Core.Types.XmlNamespaceCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.Core.Types.XmlNamespaceEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.XmlNamespaceCollection.Remove(NAnt.Core.Types.XmlNamespace)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.XmlNamespace"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.Core.Types.XmlNamespaceCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="P:NAnt.Core.Types.XmlNamespaceCollection.Item(System.String)">
- <summary>
- Gets the <see cref="T:NAnt.Core.Types.XmlNamespace"/> with the specified prefix.
- </summary>
- <param name="value">The prefix of the <see cref="T:NAnt.Core.Types.XmlNamespace"/> to get.</param>
- </member>
- <member name="T:NAnt.Core.Types.XmlNamespaceEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.Core.Types.XmlNamespace"/> elements of a <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.XmlNamespaceEnumerator.#ctor(NAnt.Core.Types.XmlNamespaceCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.XmlNamespaceEnumerator"/> class
- with the specified <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.Core.Types.XmlNamespaceEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.XmlNamespaceEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.XmlNamespaceEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.Core.Types.XsltExtensionObject">
- <summary>
- Represents an XSLT extension object. The object should have a default
- parameterless constructor and the return value should be one of the
- four basic XPath data types of number, string, Boolean or node set.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.XsltExtensionObject.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.XsltExtensionObject"/>
- class.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.XsltExtensionObject.NamespaceUri">
- <summary>
- The namespace URI to associate with the extension object.
- </summary>
- <value>
- The namespace URI to associate with the extension object, or
- <see cref="F:System.String.Empty"/> if not set.
- </value>
- </member>
- <member name="P:NAnt.Core.Types.XsltExtensionObject.TypeName">
- <summary>
- The full type name of the XSLT extension object.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.XsltExtensionObject.AssemblyPath">
- <summary>
- The assembly which contains the XSLT extension object.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.XsltExtensionObject.IfDefined">
- <summary>
- Indicates if the extension object should be added to the XSLT argument
- list. If <see langword="true" /> then the extension object will be
- added; otherwise, skipped. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.XsltExtensionObject.UnlessDefined">
- <summary>
- Indicates if the extension object should not be added to the XSLT argument
- list. If <see langword="false" /> then the extension object will be
- added; otherwise, skipped. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="T:NAnt.Core.Types.XsltExtensionObjectCollection">
- <summary>
- Contains a collection of <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> elements.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.#ctor">
- <summary>
- Initializes a new instance of the
- <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.#ctor(NAnt.Core.Types.XsltExtensionObjectCollection)">
- <summary>
- Initializes a new instance of the
- <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/> class with the
- specified <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.#ctor(NAnt.Core.Types.XsltExtensionObject[])">
- <summary>
- Initializes a new instance of the
- <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/> class with the
- specified array of <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.Add(NAnt.Core.Types.XsltExtensionObject)">
- <summary>
- Adds a <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> to be added
- to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.AddRange(NAnt.Core.Types.XsltExtensionObject[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> array to the
- end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.Core.Types.XsltExtensionObject"/>
- elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.AddRange(NAnt.Core.Types.XsltExtensionObjectCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/>
- to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/>
- to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.Contains(NAnt.Core.Types.XsltExtensionObject)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> is in the
- collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> to locate
- in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.Contains(System.String)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> with the
- specified value is in the collection.
- </summary>
- <param name="value">The argument value to locate in the
- collection.</param>
- <returns>
- <see langword="true"/> if a <see cref="T:NAnt.Core.Types.XsltExtensionObject"/>
- with value <paramref name="value"/> is found in the collection;
- otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.CopyTo(NAnt.Core.Types.XsltExtensionObject[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array,
- starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the
- destination of the elements copied from the collection. The array
- must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/>
- at which copying begins.</param>
- </member>
- <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.IndexOf(NAnt.Core.Types.XsltExtensionObject)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.Core.Types.XsltExtensionObject"/>
- object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> object for
- which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.Core.Types.XsltExtensionObject"/>. If the
- <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> is not currently a member of the
- collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.Insert(System.Int32,NAnt.Core.Types.XsltExtensionObject)">
- <summary>
- Inserts a <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> into the collection at
- the specified index.
- </summary>
- <param name="index">The zero-based index at which
- <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> to
- insert.</param>
- </member>
- <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.Core.Types.XsltExtensionObjectEnumerator"/> for the entire
- collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.Remove(NAnt.Core.Types.XsltExtensionObject)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> to remove
- from the collection.</param>
- </member>
- <member name="P:NAnt.Core.Types.XsltExtensionObjectCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get
- or set.</param>
- </member>
- <member name="P:NAnt.Core.Types.XsltExtensionObjectCollection.Item(System.String)">
- <summary>
- Gets the <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> with the specified name.
- </summary>
- <param name="value">The name of the <see cref="T:NAnt.Core.Types.XsltExtensionObject"/>
- to get.</param>
- </member>
- <member name="T:NAnt.Core.Types.XsltExtensionObjectEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> elements of a
- <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.XsltExtensionObjectEnumerator.#ctor(NAnt.Core.Types.XsltExtensionObjectCollection)">
- <summary>
- Initializes a new instance of the
- <see cref="T:NAnt.Core.Types.XsltExtensionObjectEnumerator"/> class
- with the specified <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/>.
- </summary>
- <param name="arguments">The collection that should be
- enumerated.</param>
- </member>
- <member name="M:NAnt.Core.Types.XsltExtensionObjectEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.XsltExtensionObjectEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.XsltExtensionObjectEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.Core.Types.XsltParameter">
- <summary>
- Represents an XSLT parameter.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.XsltParameter.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.XsltParameter"/>
- class.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.XsltParameter.ParameterName">
- <summary>
- The name of the XSLT parameter.
- </summary>
- <value>
- The name of the XSLT parameter, or <see cref="F:System.String.Empty"/> if
- not set.
- </value>
- </member>
- <member name="P:NAnt.Core.Types.XsltParameter.NamespaceUri">
- <summary>
- The namespace URI to associate with the parameter.
- </summary>
- <value>
- The namespace URI to associate with the parameter, or
- <see cref="F:System.String.Empty"/> if not set.
- </value>
- </member>
- <member name="P:NAnt.Core.Types.XsltParameter.Value">
- <summary>
- The value of the XSLT parameter.
- </summary>
- <value>
- The value of the XSLT parameter, or <see cref="F:System.String.Empty"/> if
- not set.
- </value>
- </member>
- <member name="P:NAnt.Core.Types.XsltParameter.IfDefined">
- <summary>
- Indicates if the parameter should be added to the XSLT argument list.
- If <see langword="true" /> then the parameter will be added;
- otherwise, skipped. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.XsltParameter.UnlessDefined">
- <summary>
- Indicates if the parameter should not be added to the XSLT argument
- list. If <see langword="false" /> then the parameter will be
- added; otherwise, skipped. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="T:NAnt.Core.Types.XsltParameterCollection">
- <summary>
- Contains a collection of <see cref="T:NAnt.Core.Types.XsltParameter"/> elements.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.XsltParameterCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.XsltParameterCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.XsltParameterCollection.#ctor(NAnt.Core.Types.XsltParameterCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.XsltParameterCollection"/> class
- with the specified <see cref="T:NAnt.Core.Types.XsltParameterCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.XsltParameterCollection.#ctor(NAnt.Core.Types.XsltParameter[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.XsltParameterCollection"/> class
- with the specified array of <see cref="T:NAnt.Core.Types.XsltParameter"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.XsltParameterCollection.Add(NAnt.Core.Types.XsltParameter)">
- <summary>
- Adds a <see cref="T:NAnt.Core.Types.XsltParameter"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.XsltParameter"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.Core.Types.XsltParameterCollection.AddRange(NAnt.Core.Types.XsltParameter[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Types.XsltParameter"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.Core.Types.XsltParameter"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Types.XsltParameterCollection.AddRange(NAnt.Core.Types.XsltParameterCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Types.XsltParameterCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.Core.Types.XsltParameterCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Types.XsltParameterCollection.Contains(NAnt.Core.Types.XsltParameter)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.Types.XsltParameter"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.XsltParameter"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.XsltParameterCollection.Contains(System.String)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.Types.XsltParameter"/> with the specified
- value is in the collection.
- </summary>
- <param name="value">The argument value to locate in the collection.</param>
- <returns>
- <see langword="true"/> if a <see cref="T:NAnt.Core.Types.XsltParameter"/> with
- value <paramref name="value"/> is found in the collection; otherwise,
- <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.XsltParameterCollection.CopyTo(NAnt.Core.Types.XsltParameter[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.Core.Types.XsltParameterCollection.IndexOf(NAnt.Core.Types.XsltParameter)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.Core.Types.XsltParameter"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.XsltParameter"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.Core.Types.XsltParameter"/>. If the <see cref="T:NAnt.Core.Types.XsltParameter"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.XsltParameterCollection.Insert(System.Int32,NAnt.Core.Types.XsltParameter)">
- <summary>
- Inserts a <see cref="T:NAnt.Core.Types.XsltParameter"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.Core.Types.XsltParameter"/> to insert.</param>
- </member>
- <member name="M:NAnt.Core.Types.XsltParameterCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.Core.Types.XsltParameterEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.XsltParameterCollection.Remove(NAnt.Core.Types.XsltParameter)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.XsltParameter"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.Core.Types.XsltParameterCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="P:NAnt.Core.Types.XsltParameterCollection.Item(System.String)">
- <summary>
- Gets the <see cref="T:NAnt.Core.Types.XsltParameter"/> with the specified name.
- </summary>
- <param name="value">The name of the <see cref="T:NAnt.Core.Types.XsltParameter"/> to get.</param>
- </member>
- <member name="T:NAnt.Core.Types.XsltParameterEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.Core.Types.XsltParameter"/> elements of a <see cref="T:NAnt.Core.Types.XsltParameterCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.XsltParameterEnumerator.#ctor(NAnt.Core.Types.XsltParameterCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.XsltParameterEnumerator"/> class
- with the specified <see cref="T:NAnt.Core.Types.XsltParameterCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.Core.Types.XsltParameterEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.XsltParameterEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.XsltParameterEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.Core.Util.AssemblyResolver">
- <summary>
- Resolves assemblies by caching assemblies that were loaded.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.AssemblyResolver.#ctor">
- <summary>
- Initializes an instanse of the <see cref="T:NAnt.Core.Util.AssemblyResolver"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.AssemblyResolver.#ctor(NAnt.Core.Task)">
- <summary>
- Initializes an instanse of the <see cref="T:NAnt.Core.Util.AssemblyResolver"/>
- class in the context of the given <see cref="T:NAnt.Core.Task"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.AssemblyResolver.Attach">
- <summary>
- Installs the assembly resolver by hooking up to the
- <see cref="F:System.AppDomain.AssemblyResolve"/> event.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.AssemblyResolver.Detach">
- <summary>
- Uninstalls the assembly resolver.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.AssemblyResolver.AssemblyResolve(System.Object,System.ResolveEventArgs)">
- <summary>
- Resolves an assembly not found by the system using the assembly
- cache.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="args">A <see cref="T:System.ResolveEventArgs"/> that contains the event data.</param>
- <returns>
- The loaded assembly, or <see langword="null"/> if not found.
- </returns>
- </member>
- <member name="M:NAnt.Core.Util.AssemblyResolver.AssemblyLoad(System.Object,System.AssemblyLoadEventArgs)">
- <summary>
- Occurs when an assembly is loaded. The loaded assembly is added
- to the assembly cache.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="args">An <see cref="T:System.AssemblyLoadEventArgs"/> that contains the event data.</param>
- </member>
- <member name="M:NAnt.Core.Util.AssemblyResolver.Log(NAnt.Core.Level,System.String,System.Object[])">
- <summary>
- Logs a message with the given priority.
- </summary>
- <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
- <param name="message">The message to log, containing zero or more format items.</param>
- <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
- <remarks>
- The actual logging is delegated to the <see cref="T:NAnt.Core.Task"/> in which
- the <see cref="T:NAnt.Core.Util.AssemblyResolver"/> is executing
- </remarks>
- </member>
- <member name="F:NAnt.Core.Util.AssemblyResolver._assemblyCache">
- <summary>
- Holds the loaded assemblies.
- </summary>
- </member>
- <member name="F:NAnt.Core.Util.AssemblyResolver._task">
- <summary>
- Holds the <see cref="T:NAnt.Core.Task"/> in which the <see cref="T:NAnt.Core.Util.AssemblyResolver"/>
- is executing.
- </summary>
- <value>
- The <see cref="T:NAnt.Core.Task"/> in which the <see cref="T:NAnt.Core.Util.AssemblyResolver"/>
- is executing or <see langword="null"/> if the <see cref="T:NAnt.Core.Util.AssemblyResolver"/>
- is not executing in the context of a <see cref="T:NAnt.Core.Task"/>.
- </value>
- </member>
- <member name="T:NAnt.Core.Util.CommandLineArgument">
- <summary>
- Represents a valid command-line argument.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgument.Finish(System.Object)">
- <summary>
- Sets the value of the argument on the specified object.
- </summary>
- <param name="destination">The object on which the value of the argument should be set.</param>
- <exception cref="T:NAnt.Core.Util.CommandLineArgumentException">The argument is required and no value was specified.</exception>
- <exception cref="T:System.NotSupportedException">
- <para>
- The matching property is collection-based, but is not initialized
- and cannot be written to.
- </para>
- <para>-or-</para>
- <para>
- The matching property is collection-based, but has no strongly-typed
- Add method.
- </para>
- <para>-or-</para>
- <para>
- The matching property is collection-based, but the signature of the
- Add method is not supported.
- </para>
- </exception>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgument.SetValue(System.String)">
- <summary>
- Assigns the specified value to the argument.
- </summary>
- <param name="value">The value that should be assigned to the argument.</param>
- <exception cref="T:NAnt.Core.Util.CommandLineArgumentException">
- <para>Duplicate argument.</para>
- <para>-or-</para>
- <para>Invalid value.</para>
- </exception>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgument.IsNameValueCollectionType(System.Type)">
- <summary>
- Indicates whether the specified <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> is a
- <see cref="T:System.Collections.Specialized.NameValueCollection"/>.
- </summary>
- <value>
- <see langword="true"/> if <paramref name="type"/> can be assigned
- to <see cref="T:System.Collections.Specialized.NameValueCollection"/>; otherwise, <see langword="false"/>.
- </value>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgument.IsCollectionType(System.Type)">
- <summary>
- Indicates whether the specified <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> is collection-based.
- </summary>
- <value>
- <see langword="true"/> if <paramref name="type"/> can be assigned
- to <see cref="T:System.Collections.ICollection"/> and is not backed by a <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/>
- that can be assigned to <see cref="T:System.Collections.Specialized.NameValueCollection"/>;
- otherwise, <see langword="false"/>.
- </value>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgument.IsArrayType(System.Type)">
- <summary>
- Indicates whether the specified <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> is an array.
- </summary>
- <value>
- <see langword="true"/> if <paramref name="type"/> is an array;
- otherwise, <see langword="false"/>.
- </value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgument.Property">
- <summary>
- Gets the property that backs the argument.
- </summary>
- <value>
- The property that backs the arguments.
- </value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgument.ValueType">
- <summary>
- Gets the underlying <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> of the argument.
- </summary>
- <value>
- The underlying <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> of the argument.
- </value>
- <remarks>
- If the <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> of the argument is a collection type,
- this property will returns the underlying type of that collection.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgument.LongName">
- <summary>
- Gets the long name of the argument.
- </summary>
- <value>The long name of the argument.</value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgument.ShortName">
- <summary>
- Gets the short name of the argument.
- </summary>
- <value>The short name of the argument.</value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgument.Description">
- <summary>
- Gets the description of the argument.
- </summary>
- <value>The description of the argument.</value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgument.IsRequired">
- <summary>
- Gets a value indicating whether the argument is required.
- </summary>
- <value>
- <see langword="true" /> if the argument is required; otherwise,
- <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgument.SeenValue">
- <summary>
- Gets a value indicating whether a mathing command-line argument
- was already found.
- </summary>
- <value>
- <see langword="true" /> if a matching command-line argument was
- already found; otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgument.AllowMultiple">
- <summary>
- Gets a value indicating whether the argument can be specified multiple
- times.
- </summary>
- <value>
- <see langword="true" /> if the argument may be specified multiple
- times; otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgument.Unique">
- <summary>
- Gets a value indicating whether the argument can only be specified once
- with a certain value.
- </summary>
- <value>
- <see langword="true" /> if the argument should always have a unique
- value; otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgument.Type">
- <summary>
- Gets the <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> of the property to which the argument
- is applied.
- </summary>
- <value>
- The <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> of the property to which the argument is
- applied.
- </value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgument.IsCollection">
- <summary>
- Gets a value indicating whether the argument is collection-based.
- </summary>
- <value>
- <see langword="true"/> if the argument is backed by a <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/>
- that can be assigned to <see cref="T:System.Collections.ICollection"/> and is not backed
- by a <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> that can be assigned to
- <see cref="T:System.Collections.Specialized.NameValueCollection"/>; otherwise, <see langword="false"/>.
- </value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgument.IsNameValueCollection">
- <summary>
- Gets a value indicating whether the argument is a set of name/value
- pairs.
- </summary>
- <value>
- <see langword="true"/> if the argument is backed by a <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/>
- that can be assigned to <see cref="T:System.Collections.Specialized.NameValueCollection"/>; otherwise,
- <see langword="false"/>.
- </value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgument.IsArray">
- <summary>
- Gets a value indicating whether the argument is array-based.
- </summary>
- <value>
- <see langword="true" /> if the argument is backed by an array;
- otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgument.IsDefault">
- <summary>
- Gets a value indicating whether the argument is the default argument.
- </summary>
- <value>
- <see langword="true" /> if the argument is the default argument;
- otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgument.IsExclusive">
- <summary>
- Gets a value indicating whether the argument cannot be combined with
- other arguments.
- </summary>
- <value>
- <see langword="true" /> if the argument cannot be combined with other
- arguments; otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="T:NAnt.Core.Util.CommandLineArgumentAttribute">
- <summary>
- Allows control of command line parsing.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentAttribute.#ctor(NAnt.Core.Util.CommandLineArgumentTypes)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentAttribute"/> class
- with the specified argument type.
- </summary>
- <param name="argumentType">Specifies the checking to be done on the argument.</param>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgumentAttribute.Type">
- <summary>
- Gets or sets the checking to be done on the argument.
- </summary>
- <value>The checking that should be done on the argument.</value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgumentAttribute.Name">
- <summary>
- Gets or sets the long name of the argument.
- </summary>
- <value>The long name of the argument.</value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgumentAttribute.ShortName">
- <summary>
- Gets or sets the short name of the argument.
- </summary>
- <value>The short name of the argument.</value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgumentAttribute.Description">
- <summary>
- Gets or sets the description of the argument.
- </summary>
- <value>The description of the argument.</value>
- </member>
- <member name="T:NAnt.Core.Util.CommandLineArgumentCollection">
- <summary>
- Contains a strongly typed collection of <see cref="T:NAnt.Core.Util.CommandLineArgument"/> objects.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.#ctor(NAnt.Core.Util.CommandLineArgumentCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/> class
- with the specified <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.#ctor(NAnt.Core.Util.CommandLineArgument[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/> class
- with the specified array of <see cref="T:NAnt.Core.Util.CommandLineArgument"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.Add(NAnt.Core.Util.CommandLineArgument)">
- <summary>
- Adds a <see cref="T:NAnt.Core.Util.CommandLineArgument"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Util.CommandLineArgument"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.AddRange(NAnt.Core.Util.CommandLineArgument[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Util.CommandLineArgument"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.Core.Util.CommandLineArgument"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.AddRange(NAnt.Core.Util.CommandLineArgumentCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.Contains(NAnt.Core.Util.CommandLineArgument)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.Util.CommandLineArgument"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Util.CommandLineArgument"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.CopyTo(NAnt.Core.Util.CommandLineArgument[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.IndexOf(NAnt.Core.Util.CommandLineArgument)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.Core.Util.CommandLineArgument"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Util.CommandLineArgument"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.Core.Util.CommandLineArgument"/>. If the <see cref="T:NAnt.Core.Util.CommandLineArgument"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.Insert(System.Int32,NAnt.Core.Util.CommandLineArgument)">
- <summary>
- Inserts a <see cref="T:NAnt.Core.Util.CommandLineArgument"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.Core.Util.CommandLineArgument"/> to insert.</param>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.Core.Util.CommandLineArgumentEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.Remove(NAnt.Core.Util.CommandLineArgument)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Util.CommandLineArgument"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgumentCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgumentCollection.Item(System.String)">
- <summary>
- Gets the <see cref="T:NAnt.Core.Util.CommandLineArgument"/> with the specified name.
- </summary>
- <param name="name">The name of the <see cref="T:NAnt.Core.Util.CommandLineArgument"/> to get.</param>
- </member>
- <member name="T:NAnt.Core.Util.CommandLineArgumentEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.Core.Util.CommandLineArgument"/> elements of a <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentEnumerator.#ctor(NAnt.Core.Util.CommandLineArgumentCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentEnumerator"/> class
- with the specified <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgumentEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.Core.Util.CommandLineArgumentException">
- <summary>
- The exception that is thrown when one of the command-line arguments provided
- is not valid.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentException"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentException"/> class
- with a descriptive message.
- </summary>
- <param name="message">A descriptive message to include with the exception.</param>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentException"/> class
- with a descriptive message and an inner exception.
- </summary>
- <param name="message">A descriptive message to include with the exception.</param>
- <param name="innerException">A nested exception that is the cause of the current exception.</param>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentException"/> class
- with serialized data.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- </member>
- <member name="T:NAnt.Core.Util.CommandLineArgumentTypes">
- <summary>
- Used to control parsing of command-line arguments.
- </summary>
- </member>
- <member name="F:NAnt.Core.Util.CommandLineArgumentTypes.Required">
- <summary>
- Indicates that this field is required. An error will be displayed
- if it is not present when parsing arguments.
- </summary>
- </member>
- <member name="F:NAnt.Core.Util.CommandLineArgumentTypes.Unique">
- <summary>
- Only valid in conjunction with Multiple.
- Duplicate values will result in an error.
- </summary>
- </member>
- <member name="F:NAnt.Core.Util.CommandLineArgumentTypes.Multiple">
- <summary>
- Inidicates that the argument may be specified more than once.
- Only valid if the argument is a collection
- </summary>
- </member>
- <member name="F:NAnt.Core.Util.CommandLineArgumentTypes.Exclusive">
- <summary>
- Inidicates that if this argument is specified, no other arguments may be specified.
- </summary>
- </member>
- <member name="F:NAnt.Core.Util.CommandLineArgumentTypes.AtMostOnce">
- <summary>
- The default type for non-collection arguments.
- The argument is not required, but an error will be reported if it is specified more than once.
- </summary>
- </member>
- <member name="F:NAnt.Core.Util.CommandLineArgumentTypes.MultipleUnique">
- <summary>
- The default type for collection arguments.
- The argument is permitted to occur multiple times, but duplicate
- values will cause an error to be reported.
- </summary>
- </member>
- <member name="T:NAnt.Core.Util.CommandLineParser">
- <summary>
- Commandline parser.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineParser.#ctor(System.Type,System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineParser"/> class
- using possible arguments deducted from the specific <see cref="T:System.Type"/>.
- </summary>
- <param name="argumentSpecification">The <see cref="T:System.Type"/> from which the possible command-line arguments should be retrieved.</param>
- <param name="supportsResponseFile">A <see cref="T:System.Boolean"/> value indicating whether or not a response file is able to be used. </param>
- <exception cref="T:System.ArgumentNullException"><paramref name="argumentSpecification"/> is a null reference.</exception>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineParser.Parse(System.String[],System.Object)">
- <summary>
- Parses an argument list.
- </summary>
- <param name="args">The arguments to parse.</param>
- <param name="destination">The destination object on which properties will be set corresponding to the specified arguments.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="destination"/> is a null reference.</exception>
- <exception cref="T:System.ArgumentException">The <see cref="T:System.Type"/> of <paramref name="destination"/> does not match the argument specification that was used to initialize the parser.</exception>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineParser.SplitStringNoNulls(System.String,System.Char[])">
- <summary>
- Splits a string and removes any empty strings from the
- result. Same functionality as the
- public string[] Split(char[] separator, StringSplitOptions options)
- method in .Net 2.0. Replace with that call when 2.0 is standard.
- </summary>
- <param name="sourceString"></param>
- <param name="delimiters"></param>
- <returns>the array of strings</returns>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineParser.ProcessResponseFile(System.String)">
- <summary>
- Read a response file and parse the arguments as usual.
- </summary>
- <param name="file"></param>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineParser.ParseArgumentList(System.String[])">
- <summary>
- Parse the argument list using the
- </summary>
- <param name="args"></param>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineParser.GetCommandLineAttribute(System.Reflection.PropertyInfo)">
- <summary>
- Returns the <see cref="T:NAnt.Core.Util.CommandLineArgumentAttribute"/> that's applied
- on the specified property.
- </summary>
- <param name="propertyInfo">The property of which applied <see cref="T:NAnt.Core.Util.CommandLineArgumentAttribute"/> should be returned.</param>
- <returns>
- The <see cref="T:NAnt.Core.Util.CommandLineArgumentAttribute"/> that's applied to the
- <paramref name="propertyInfo"/>, or a null reference if none was applied.
- </returns>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineParser.LogoBanner">
- <summary>
- Gets a logo banner using version and copyright attributes defined on the
- <see cref="M:System.Reflection.Assembly.GetEntryAssembly"/> or the
- <see cref="M:System.Reflection.Assembly.GetCallingAssembly"/>.
- </summary>
- <value>
- A logo banner.
- </value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineParser.Usage">
- <summary>
- Gets the usage instructions.
- </summary>
- <value>The usage instructions.</value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineParser.NoArgs">
- <summary>
- Gets a value indicating whether no arguments were specified on the
- command line.
- </summary>
- </member>
- <member name="T:NAnt.Core.Util.DefaultCommandLineArgumentAttribute">
- <summary>
- Marks a command-line option as being the default option. When the name of
- a command-line argument is not specified, this option will be assumed.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.DefaultCommandLineArgumentAttribute.#ctor(NAnt.Core.Util.CommandLineArgumentTypes)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentAttribute"/> class
- with the specified argument type.
- </summary>
- <param name="argumentType">Specifies the checking to be done on the argument.</param>
- </member>
- <member name="T:NAnt.Core.Util.FileUtils">
- <summary>
- Provides modified version for Copy and Move from the File class that
- allow for filter chain processing.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.FileUtils.CopyFile(System.String,System.String,NAnt.Core.Filters.FilterChain,System.Text.Encoding,System.Text.Encoding)">
- <summary>
- Copies a file filtering its content through the filter chain.
- </summary>
- <param name="sourceFileName">The file to copy</param>
- <param name="destFileName">The file to copy to</param>
- <param name="filterChain">Chain of filters to apply when copying, or <see langword="null" /> is no filters should be applied.</param>
- <param name="inputEncoding">The encoding used to read the soure file.</param>
- <param name="outputEncoding">The encoding used to write the destination file.</param>
- </member>
- <member name="M:NAnt.Core.Util.FileUtils.MoveFile(System.String,System.String,NAnt.Core.Filters.FilterChain,System.Text.Encoding,System.Text.Encoding)">
- <summary>
- Moves a file filtering its content through the filter chain.
- </summary>
- <param name="sourceFileName">The file to move</param>
- <param name="destFileName">The file to move move to</param>
- <param name="filterChain">Chain of filters to apply when moving, or <see langword="null" /> is no filters should be applied.</param>
- <param name="inputEncoding">The encoding used to read the soure file.</param>
- <param name="outputEncoding">The encoding used to write the destination file.</param>
- </member>
- <member name="M:NAnt.Core.Util.FileUtils.GetTempDirectory">
- <summary>
- Returns a uniquely named empty temporary directory on disk.
- </summary>
- <value>
- A <see cref="T:System.IO.DirectoryInfo"/> representing the temporary directory.
- </value>
- </member>
- <member name="M:NAnt.Core.Util.FileUtils.CombinePaths(System.String,System.String)">
- <summary>
- Combines two path strings.
- </summary>
- <param name="path1">The first path.</param>
- <param name="path2">The second path.</param>
- <returns>
- A string containing the combined paths. If one of the specified
- paths is a zero-length string, this method returns the other path.
- If <paramref name="path2"/> contains an absolute path, this method
- returns <paramref name="path2"/>.
- </returns>
- <remarks>
- <para>
- On *nix, processing is delegated to <see cref="M:System.IO.Path.Combine(System.String,System.String)"/>.
- </para>
- <para>
- On Windows, this method normalized the paths to avoid running into
- the 260 character limit of a path and converts forward slashes in
- both <paramref name="path1"/> and <paramref name="path2"/> to
- the platform's directory separator character.
- </para>
- </remarks>
- </member>
- <member name="M:NAnt.Core.Util.FileUtils.GetFullPath(System.String)">
- <summary>
- Returns Absolute Path (Fix for 260 Char Limit of Path.GetFullPath(...))
- </summary>
- <param name="path">The file or directory for which to obtain absolute path information.</param>
- <returns>Path Resolved</returns>
- <exception cref="T:System.ArgumentException">path is a zero-length string, contains only white space or contains one or more invalid characters as defined by <see cref="F:System.IO.Path.InvalidPathChars"/>.</exception>
- <exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
- </member>
- <member name="M:NAnt.Core.Util.FileUtils.GetHomeDirectory">
- <summary>
- Returns the home directory of the current user.
- </summary>
- <returns>
- The home directory of the current user.
- </returns>
- </member>
- <member name="T:NAnt.Core.Util.GacCache">
- <summary>
- Helper class for determining whether assemblies are located in the
- Global Assembly Cache.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.GacCache.#ctor(NAnt.Core.Project)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Util.GacCache"/> class in
- the context of the given <see cref="P:NAnt.Core.Util.GacCache.Project"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.GacCache.IsAssemblyInGac(System.String)">
- <summary>
- Determines whether an assembly is installed in the Global
- Assembly Cache given its file name or path.
- </summary>
- <param name="assemblyFile">The name or path of the file that contains the manifest of the assembly.</param>
- <returns>
- <see langword="true"/> if <paramref name="assemblyFile"/> is
- installed in the Global Assembly Cache; otherwise,
- <see langword="false"/>.
- </returns>
- <remarks>
- <para>
- To determine whether the specified assembly is installed in the
- Global Assembly Cache, the assembly is loaded into a separate
- <see cref="T:System.AppDomain"/>.
- </para>
- <para>
- If the family of the current runtime framework does not match the
- family of the current target framework, this method will return
- <see langword="false"/> for all assemblies as there's no way to
- determine whether a given assembly is in the Global Assembly Cache
- for another framework family than the family of the current runtime
- framework.
- </para>
- </remarks>
- </member>
- <member name="F:NAnt.Core.Util.GacCache._domain">
- <summary>
- Holds the <see cref="T:System.AppDomain"/> in which assemblies will be loaded
- to determine whether they are in the Global Assembly Cache.
- </summary>
- </member>
- <member name="F:NAnt.Core.Util.GacCache._project">
- <summary>
- Holds the <see cref="P:NAnt.Core.Util.GacCache.Project"/> context of the <see cref="T:NAnt.Core.Util.GacCache"/>.
- </summary>
- </member>
- <member name="F:NAnt.Core.Util.GacCache._gacQueryCache">
- <summary>
- Holds a list of assembly files for which already has been determined
- whether they are located in the Global Assembly Cache.
- </summary>
- <remarks>
- <para>
- The key of the <see cref="T:System.Collections.Hashtable"/> is the full path to the
- assembly file and the value is a <see cref="T:System.Boolean"/> indicating
- whether the assembly is located in the Global Assembly Cache.
- </para>
- </remarks>
- </member>
- <member name="F:NAnt.Core.Util.GacCache._disposed">
- <summary>
- Holds a value indicating whether the object has been disposed.
- </summary>
- </member>
- <member name="P:NAnt.Core.Util.GacCache.Project">
- <summary>
- Gets the <see cref="P:NAnt.Core.Util.GacCache.Project"/> context of the <see cref="T:NAnt.Core.Util.GacCache"/>.
- </summary>
- <value>
- The <see cref="P:NAnt.Core.Util.GacCache.Project"/> context of the <see cref="T:NAnt.Core.Util.GacCache"/>.
- </value>
- </member>
- <member name="M:NAnt.Core.Util.GacCache.GacResolver.InitializeLifetimeService">
- <summary>
- Obtains a lifetime service object to control the lifetime policy for
- this instance.
- </summary>
- <returns>
- An object of type <see cref="T:System.Runtime.Remoting.Lifetime.ILease"/> used to control the lifetime
- policy for this instance. This is the current lifetime service object
- for this instance if one exists; otherwise, a new lifetime service
- object initialized with a lease that will never time out.
- </returns>
- </member>
- <member name="M:NAnt.Core.Util.GacCache.GacResolver.IsAssemblyInGac(System.String)">
- <summary>
- Determines whether an assembly is installed in the Global
- Assembly Cache given its file name or path.
- </summary>
- <param name="assemblyFile">The name or path of the file that contains the manifest of the assembly.</param>
- <returns>
- <see langword="true" /> if <paramref name="assemblyFile" /> is
- installed in the Global Assembly Cache; otherwise,
- <see langword="false" />.
- </returns>
- </member>
- <member name="T:NAnt.Core.Util.ReflectionUtils">
- <summary>
- Provides a set of helper methods related to reflection.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.ReflectionUtils.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Util.ReflectionUtils"/> class.
- </summary>
- <remarks>
- Uses a private access modifier to prevent instantiation of this class.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Util.ReflectionUtils.GetTypeFromString(System.String,System.Boolean)">
- <summary>
- Loads the type specified in the type string with assembly qualified name.
- </summary>
- <param name="typeName">The assembly qualified name of the type to load.</param>
- <param name="throwOnError">Flag set to <see langword="true"/> to throw an exception if the type cannot be loaded.</param>
- <exception cref="T:System.TypeLoadException">
- <paramref name="throwOnError"/> is <see langword="true"/> and
- an error is encountered while loading the <see cref="T:System.Type"/>, or
- <paramref name="typeName"/> is not an assembly qualified name.
- </exception>
- <remarks>
- If the <see cref="T:System.Type"/> cannot be instantiated from the assembly
- qualified type name, then we'll try to instantiate the type using its
- simple type name from an already loaded assembly with an assembly
- name mathing the assembly in the assembly qualified type name.
- </remarks>
- <returns>
- The type loaded or <see langword="null"/> if it could not be loaded.
- </returns>
- </member>
- <member name="T:NAnt.Core.Util.ResourceUtils">
- <summary>
- Provides resource support to NAnt assemblies. This class cannot
- be inherited from.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.ResourceUtils.#ctor">
- <summary>
- Prevents the <see cref="T:NAnt.Core.Util.ResourceUtils"/> class from being
- instantiated explicitly.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.ResourceUtils.RegisterSharedAssembly(System.Reflection.Assembly)">
- <summary>
- Registers the assembly to be used as the fallback if resources
- aren't found in the local satellite assembly.
- </summary>
- <param name="assembly">
- A <see cref="T:System.Reflection.Assembly"/> that represents the
- assembly to register.
- </param>
- <example>
- The following example shows how to register a shared satellite
- assembly.
- <code>
- <![CDATA[
- Assembly sharedAssembly = Assembly.Load("MyResources.dll");
- ResourceUtils.RegisterSharedAssembly(sharedAssembly);
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Util.ResourceUtils.GetString(System.String)">
- <summary>
- Returns the value of the specified string resource.
- </summary>
- <param name="name">
- A <see cref="T:System.String"/> that contains the name of the
- resource to get.
- </param>
- <returns>
- A <see cref="T:System.String"/> that contains the value of the
- resource localized for the current culture.
- </returns>
- <remarks>
- The returned resource is localized for the cultural settings of the
- current <see cref="T:System.Threading.Thread"/>.
- <note>
- The <c>GetString</c> method is thread-safe.
- </note>
- </remarks>
- <example>
- The following example demonstrates the <c>GetString</c> method using
- the cultural settings of the current <see cref="T:System.Threading.Thread"/>.
- <code>
- <![CDATA[
- string localizedString = ResourceUtils.GetString("String_HelloWorld");
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Util.ResourceUtils.GetString(System.String,System.Globalization.CultureInfo)">
- <summary>
- Returns the value of the specified string resource localized for
- the specified culture.
- </summary>
- <param name="name"></param>
- <param name="culture"></param>
- <returns>
- A <see cref="T:System.String"/> that contains the value of the
- resource localized for the specified culture.
- </returns>
- <remarks>
- <note>
- The <c>GetString</c> method is thread-safe.
- </note>
- </remarks>
- <example>
- The following example demonstrates the <c>GetString</c> method using
- a specific culture.
- <code>
- <![CDATA[
- CultureInfo culture = CultureInfo.CreateSpecificCulture("en-US");
- string localizedString = ResourceUtils.GetString("String_HelloWorld", culture);
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Util.ResourceUtils.GetString(System.String,System.Globalization.CultureInfo,System.Reflection.Assembly)">
- <summary>
- Returns the value of the specified string resource localized for
- the specified culture for the specified assembly.
- </summary>
- <param name="name">
- A <see cref="T:System.String"/> that contains the name of the
- resource to get.
- </param>
- <param name="culture">
- A <see cref="T:System.Globalization.CultureInfo"/> that represents
- the culture for which the resource is localized.
- </param>
- <param name="assembly">
- A <see cref="T:System.Reflection.Assembly"/>
- </param>
- <returns>
- A <see cref="T:System.String"/> that contains the value of the
- resource localized for the specified culture.
- </returns>
- <remarks>
- <note>
- The <c>GetString</c> method is thread-safe.
- </note>
- </remarks>
- <example>
- The following example demonstrates the <c>GetString</c> method using
- specific culture and assembly.
- <code>
- <![CDATA[
- CultureInfo culture = CultureInfo.CreateSpecificCulture("en-US");
- Assembly assembly = Assembly.GetCallingAssembly();
- string localizedString = ResourceUtils.GetString("String_HelloWorld", culture, assembly);
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Util.ResourceUtils.RegisterAssembly(System.Reflection.Assembly)">
- <summary>
- Registers the specified assembly.
- </summary>
- <param name="assembly">
- A <see cref="T:System.Reflection.Assembly"/> that represents the
- assembly to register.
- </param>
- </member>
- <member name="M:NAnt.Core.Util.ResourceUtils.GetResourceName(System.String)">
- <summary>
- Determines the manifest resource name of the resource holding the
- localized strings.
- </summary>
- <param name="assemblyName">The name of the assembly.</param>
- <returns>
- The manifest resource name of the resource holding the localized
- strings for the specified assembly.
- </returns>
- <remarks>
- The manifest resource name of the resource holding the localized
- strings should match the name of the assembly, minus <c>Tasks</c>
- suffix.
- </remarks>
- </member>
- <member name="T:NAnt.Core.Util.StringUtils">
- <summary>
- Groups a set of useful <see cref="T:System.String"/> manipulation and validation
- methods.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.StringUtils.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Util.StringUtils"/> class.
- </summary>
- <remarks>
- Prevents instantiation of the <see cref="T:NAnt.Core.Util.StringUtils"/> class.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Util.StringUtils.EndsWith(System.String,System.Char)">
- <summary>
- Determines whether the last character of the given <see cref="T:System.String"/>
- matches the specified character.
- </summary>
- <param name="value">The string.</param>
- <param name="c">The character.</param>
- <returns>
- <see langword="true"/> if the last character of <paramref name="value"/>
- matches <paramref name="c"/>; otherwise, <see langword="false"/>.
- </returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <see langword="null"/>.</exception>
- </member>
- <member name="M:NAnt.Core.Util.StringUtils.IsNullOrEmpty(System.String)">
- <summary>
- Indicates whether or not the specified <see cref="T:System.String"/> is
- <see langword="null"/> or an <see cref="F:System.String.Empty"/> string.
- </summary>
- <param name="value">The value to check.</param>
- <returns>
- <see langword="true"/> if <paramref name="value"/> is <see langword="null"/>
- or an empty string (""); otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Util.StringUtils.ConvertEmptyToNull(System.String)">
- <summary>
- Converts an empty string ("") to <see langword="null" />.
- </summary>
- <param name="value">The value to convert.</param>
- <returns>
- <see langword="null" /> if <paramref name="value" /> is an empty
- string ("") or <see langword="null" />; otherwise, <paramref name="value" />.
- </returns>
- </member>
- <member name="M:NAnt.Core.Util.StringUtils.ConvertNullToEmpty(System.String)">
- <summary>
- Converts <see langword="null" /> to an empty string.
- </summary>
- <param name="value">The value to convert.</param>
- <returns>
- An empty string if <paramref name="value" /> is <see langword="null" />;
- otherwise, <paramref name="value" />.
- </returns>
- </member>
- <member name="M:NAnt.Core.Util.StringUtils.Join(System.String,System.Collections.Specialized.StringCollection)">
- <summary>
- Concatenates a specified separator <see cref="T:System.String"/> between each
- element of a specified <see cref="T:System.Collections.Specialized.StringCollection"/>, yielding a
- single concatenated string.
- </summary>
- <param name="separator">A <see cref="T:System.String"/>.</param>
- <param name="value">A <see cref="T:System.Collections.Specialized.StringCollection"/>.</param>
- <returns>
- A <see cref="T:System.String"/> consisting of the elements of <paramref name="value"/>
- interspersed with the separator string.
- </returns>
- <remarks>
- <para>
- For example if <paramref name="separator"/> is ", " and the elements
- of <paramref name="value"/> are "apple", "orange", "grape", and "pear",
- <see cref="M:NAnt.Core.Util.StringUtils.Join(System.String,System.Collections.Specialized.StringCollection)"/> returns "apple, orange,
- grape, pear".
- </para>
- <para>
- If <paramref name="separator"/> is <see langword="null"/>, an empty
- string (<see cref="F:System.String.Empty"/>) is used instead.
- </para>
- </remarks>
- </member>
- <member name="M:NAnt.Core.Util.StringUtils.Clone(System.Collections.Specialized.StringCollection)">
- <summary>
- Creates a shallow copy of the specified <see cref="T:System.Collections.Specialized.StringCollection"/>.
- </summary>
- <param name="stringCollection">The <see cref="T:System.Collections.Specialized.StringCollection"/> that should be copied.</param>
- <returns>
- A shallow copy of the specified <see cref="T:System.Collections.Specialized.StringCollection"/>.
- </returns>
- </member>
- <member name="T:NAnt.Core.BuildException">
- <summary>
- Thrown whenever an error occurs during the build.
- </summary>
- </member>
- <member name="F:NAnt.Core.BuildException._location">
- <summary>
- The location of the exception in the build document (xml file).
- </summary>
- </member>
- <member name="M:NAnt.Core.BuildException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.BuildException"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.BuildException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.BuildException"/> class
- with a descriptive message.
- </summary>
- <param name="message">A descriptive message to include with the exception.</param>
- </member>
- <member name="M:NAnt.Core.BuildException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.BuildException"/> class
- with the specified descriptive message and inner exception.
- </summary>
- <param name="message">A descriptive message to include with the exception.</param>
- <param name="innerException">A nested exception that is the cause of the current exception.</param>
- </member>
- <member name="M:NAnt.Core.BuildException.#ctor(System.String,NAnt.Core.Location)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.BuildException"/> class
- with a descriptive message and the location in the build file that
- caused the exception.
- </summary>
- <param name="message">A descriptive message to include with the exception.</param>
- <param name="location">The location in the build file where the exception occured.</param>
- </member>
- <member name="M:NAnt.Core.BuildException.#ctor(System.String,NAnt.Core.Location,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.BuildException"/> class
- with a descriptive message, the location in the build file and an
- instance of the exception that is the cause of the current exception.
- </summary>
- <param name="message">A descriptive message to include with the exception.</param>
- <param name="location">The location in the build file where the exception occured.</param>
- <param name="innerException">A nested exception that is the cause of the current exception.</param>
- </member>
- <member name="M:NAnt.Core.BuildException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.BuildException"/> class
- with serialized data.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- </member>
- <member name="M:NAnt.Core.BuildException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Serializes this object into the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> provided.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> to populate with data.</param>
- <param name="context">The destination for this serialization.</param>
- </member>
- <member name="M:NAnt.Core.BuildException.ToString">
- <summary>
- Creates and returns a string representation of the current
- exception.
- </summary>
- <returns>
- A string representation of the current exception.
- </returns>
- </member>
- <member name="P:NAnt.Core.BuildException.RawMessage">
- <summary>
- Gets the raw message as specified when the exception was
- constructed.
- </summary>
- <value>
- The raw message as specified when the exception was
- constructed.
- </value>
- </member>
- <member name="P:NAnt.Core.BuildException.Location">
- <summary>
- Gets the location in the build file of the element from which the
- exception originated.
- </summary>
- <value>
- The location in the build file of the element from which the
- exception originated.
- </value>
- </member>
- <member name="P:NAnt.Core.BuildException.Message">
- <summary>
- Gets a message that describes the current exception.
- </summary>
- <value>
- The error message that explains the reason for the exception.
- </value>
- <remarks>
- Adds location information to the message, if available.
- </remarks>
- </member>
- <member name="T:NAnt.Core.CommandLineOptions">
- <summary>
- Represents the set of command-line options supported by NAnt.
- </summary>
- </member>
- <member name="P:NAnt.Core.CommandLineOptions.TargetFramework">
- <summary>
- Gets or sets the target framework to use (overrides
- NAnt.exe.config settings)
- </summary>
- <value>
- The framework that should be used.
- </value>
- <remarks>
- For a list of possible frameworks, see NAnt.exe.config, possible
- values include "net-1.0", "net-1.1", etc.
- </remarks>
- </member>
- <member name="P:NAnt.Core.CommandLineOptions.DefaultFramework">
- <summary>
- Gets or sets the target framework to use (overrides
- NAnt.exe.config settings)
- </summary>
- <value>
- The framework that should be used.
- </value>
- <remarks>
- For a list of possible frameworks, see NAnt.exe.config, possible
- values include "net-1.0", "net-1.1", etc.
- </remarks>
- </member>
- <member name="P:NAnt.Core.CommandLineOptions.BuildFile">
- <summary>
- Gets or sets the buildfile that should be executed.
- </summary>
- <value>
- The buildfile that should be executed.
- </value>
- <remarks>
- Can be both a file or an URI.
- </remarks>
- </member>
- <member name="P:NAnt.Core.CommandLineOptions.Verbose">
- <summary>
- Gets or sets a value indicating whether more information should be
- displayed during the build process.
- </summary>
- <value>
- <see langword="true" /> if more information should be displayed;
- otherwise, <see langword="false" />. The default is <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.CommandLineOptions.Debug">
- <summary>
- Gets or sets a value indicating whether debug information should be
- displayed during the build process.
- </summary>
- <value>
- <see langword="true" /> if debug information should be displayed;
- otherwise, <see langword="false" />. The default is <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.CommandLineOptions.Quiet">
- <summary>
- Gets or sets a value indicating whether only error and debug debug messages should be
- displayed during the build process.
- </summary>
- <value>
- <see langword="true" /> if only error or warning messages should be
- displayed; otherwise, <see langword="false" />. The default is
- <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.CommandLineOptions.EmacsMode">
- <summary>
- Gets or sets a value indicating whether to produce emacs (and other
- editor) friendly output.
- </summary>
- <value>
- <see langword="true" /> if output is to be unadorned so that emacs
- and other editors can parse files names, etc. The default is
- <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.CommandLineOptions.FindInParent">
- <summary>
- Gets a value indicating whether parent directories should be searched
- for a buildfile.
- </summary>
- <value>
- <see langword="true" /> if parent directories should be searched for
- a build file; otherwise, <see langword="false" />. The default is
- <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.CommandLineOptions.IndentationLevel">
- <summary>
- Gets or sets the indentation level of the build output.
- </summary>
- <value>
- The indentation level of the build output. The default is <c>0</c>.
- </value>
- </member>
- <member name="P:NAnt.Core.CommandLineOptions.Properties">
- <summary>
- Gets or sets the list of properties that should be set.
- </summary>
- <value>
- The list of properties that should be set.
- </value>
- </member>
- <member name="P:NAnt.Core.CommandLineOptions.LoggerType">
- <summary>
- Gets or sets the <see cref="T:System.Type"/> of logger to add to the list
- of listeners.
- </summary>
- <value>
- The <see cref="T:System.Type"/> of logger to add to the list of
- listeners.
- </value>
- <remarks>
- The <see cref="P:NAnt.Core.CommandLineOptions.LoggerType"/> should derive from <see cref="T:NAnt.Core.IBuildLogger"/>.
- </remarks>
- </member>
- <member name="P:NAnt.Core.CommandLineOptions.LogFile">
- <summary>
- Gets or sets the name of the file to log output to.
- </summary>
- <value>
- The name of the file to log output to.
- </value>
- </member>
- <member name="P:NAnt.Core.CommandLineOptions.Listeners">
- <summary>
- Gets a collection containing fully qualified type names of classes
- implementating <see cref="T:NAnt.Core.IBuildListener"/> that should be added
- to the project as listeners.
- </summary>
- <value>
- A collection of fully qualified type names that should be added as
- listeners to the <see cref="T:NAnt.Core.Project"/>.
- </value>
- </member>
- <member name="P:NAnt.Core.CommandLineOptions.ExtensionAssemblies">
- <summary>
- Gets a collection of assemblies to load extensions from.
- </summary>
- <value>
- A collection of assemblies to load extensions from.
- </value>
- </member>
- <member name="P:NAnt.Core.CommandLineOptions.ShowProjectHelp">
- <summary>
- Gets or sets a value indicating whether <see cref="T:NAnt.Core.Project"/> help
- should be printed.
- </summary>
- <value>
- <see langword="true"/> if <see cref="T:NAnt.Core.Project"/> help should be
- printed; otherwise, <see langword="false"/>. The default is
- <see langword="false"/>.
- </value>
- </member>
- <member name="P:NAnt.Core.CommandLineOptions.NoLogo">
- <summary>
- Gets or sets a value indicating whether the logo banner should be
- printed.
- </summary>
- <value>
- <see langword="true" /> if the logo banner should be printed; otherwise,
- <see langword="false" />. The default is <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.CommandLineOptions.ShowHelp">
- <summary>
- Gets or sets a value indicating whether the NAnt help should be
- printed.
- </summary>
- <value>
- <see langword="true" /> if NAnt help should be printed; otherwise,
- <see langword="false" />. The default is <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.CommandLineOptions.Targets">
- <summary>
- Gets a collection containing the targets that should be executed.
- </summary>
- <value>
- A collection that contains the targets that should be executed.
- </value>
- </member>
- <member name="T:NAnt.Core.ConfigurationSection">
- <summary>
- Custom configuration section handler for the <nantsettings/> element.
- </summary>
- </member>
- <member name="M:NAnt.Core.ConfigurationSection.Create(System.Object,System.Object,System.Xml.XmlNode)">
- <summary>
- This just passed things through. Return the node read from the config file.
- </summary>
- </member>
- <member name="T:NAnt.Core.ConsoleDriver">
- <summary>
- Main entry point to NAnt that is called by the ConsoleStub.
- </summary>
- </member>
- <member name="M:NAnt.Core.ConsoleDriver.Main(System.String[])">
- <summary>
- Starts NAnt. This is the Main entry point.
- </summary>
- <param name="args">Command Line args, or whatever you want to pass it. They will treated as Command Line args.</param>
- <returns>
- The exit code.
- </returns>
- </member>
- <member name="M:NAnt.Core.ConsoleDriver.ShowProjectHelp(System.Xml.XmlDocument)">
- <summary>
- Prints the projecthelp to the console.
- </summary>
- <param name="buildDoc">The build file to show help for.</param>
- <remarks>
- <paramref name="buildDoc" /> is loaded and transformed with
- <c>ProjectHelp.xslt</c>, which is an embedded resource.
- </remarks>
- </member>
- <member name="M:NAnt.Core.ConsoleDriver.GetBuildFileName(System.String,System.String,System.Boolean)">
- <summary>
- Gets the file name for the build file in the specified directory.
- </summary>
- <param name="directory">The directory to look for a build file. When in doubt use Environment.CurrentDirectory for directory.</param>
- <param name="searchPattern">Look for a build file with this pattern or name. If null look for a file that matches the default build pattern (*.build).</param>
- <param name="findInParent">Whether or not to search the parent directories for a build file.</param>
- <returns>The path to the build file or <c>null</c> if no build file could be found.</returns>
- </member>
- <member name="M:NAnt.Core.ConsoleDriver.LoadExtensionAssemblies(System.Collections.Specialized.StringCollection,NAnt.Core.Project)">
- <summary>
- Loads the extension assemblies in the current <see cref="T:System.AppDomain"/>
- and scans them for extensions.
- </summary>
- <param name="extensionAssemblies">The extension assemblies to load.</param>
- <param name="project">The <see cref="T:NAnt.Core.Project"/> which will be used to output messages to the build log.</param>
- </member>
- <member name="M:NAnt.Core.ConsoleDriver.CreateLogger(System.String)">
- <summary>
- Dynamically constructs an <see cref="T:NAnt.Core.IBuildLogger"/> instance of
- the class specified.
- </summary>
- <remarks>
- <para>
- At this point, only looks in the assembly where <see cref="T:NAnt.Core.IBuildLogger"/>
- is defined.
- </para>
- </remarks>
- <param name="typeName">The fully qualified name of the logger that should be instantiated.</param>
- <exception cref="T:System.TypeLoadException">Type <paramref name="typeName"/> could not be loaded.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="typeName"/> does not implement <see cref="T:NAnt.Core.IBuildLogger"/>.</exception>
- </member>
- <member name="M:NAnt.Core.ConsoleDriver.CreateListener(System.String)">
- <summary>
- Dynamically constructs an <see cref="T:NAnt.Core.IBuildListener"/> instance of
- the class specified.
- </summary>
- <remarks>
- <para>
- At this point, only looks in the assembly where <see cref="T:NAnt.Core.IBuildListener"/>
- is defined.
- </para>
- </remarks>
- <param name="typeName">The fully qualified name of the listener that should be instantiated.</param>
- <exception cref="T:System.TypeLoadException">Type <paramref name="typeName"/> could not be loaded.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="typeName"/> does not implement <see cref="T:NAnt.Core.IBuildListener"/>.</exception>
- </member>
- <member name="M:NAnt.Core.ConsoleDriver.AddBuildListeners(NAnt.Core.CommandLineOptions,NAnt.Core.Project)">
- <summary>
- Add the listeners specified in the command line arguments,
- along with the default listener, to the specified project.
- </summary>
- <param name="cmdlineOptions">The command-line options.</param>
- <param name="project">The <see cref="T:NAnt.Core.Project"/> to add listeners to.</param>
- </member>
- <member name="M:NAnt.Core.ConsoleDriver.ShowHelp(NAnt.Core.Util.CommandLineParser)">
- <summary>
- Spits out generic help info to the console.
- </summary>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseBuilder.#ctor(System.Reflection.Assembly,System.String)">
- <summary>
- Creates a new instance of the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/>
- class for the specified <see cref="T:NAnt.Core.DataTypeBase"/> class in the
- <see cref="P:NAnt.Core.DataTypeBaseBuilder.Assembly"/> specified.
- </summary>
- <param name="assembly">The <see cref="P:NAnt.Core.DataTypeBaseBuilder.Assembly"/> containing the <see cref="T:NAnt.Core.DataTypeBase"/>.</param>
- <param name="className">The class representing the <see cref="T:NAnt.Core.DataTypeBase"/>.</param>
- </member>
- <member name="P:NAnt.Core.DataTypeBaseBuilder.ClassName">
- <summary>
- Gets the name of the <see cref="T:NAnt.Core.DataTypeBase"/> class that can be
- created using this <see cref="T:NAnt.Core.DataTypeBaseBuilder"/>.
- </summary>
- <value>
- The name of the <see cref="T:NAnt.Core.DataTypeBase"/> class that can be created
- using this <see cref="T:NAnt.Core.DataTypeBaseBuilder"/>.
- </value>
- </member>
- <member name="P:NAnt.Core.DataTypeBaseBuilder.Assembly">
- <summary>
- Gets the <see cref="P:NAnt.Core.DataTypeBaseBuilder.Assembly"/> from which the data type will be
- created.
- </summary>
- <value>
- The <see cref="P:NAnt.Core.DataTypeBaseBuilder.Assembly"/> containing the data type.
- </value>
- </member>
- <member name="P:NAnt.Core.DataTypeBaseBuilder.DataTypeName">
- <summary>
- Gets the name of the data type which the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/>
- can create.
- </summary>
- <value>
- The name of the data type which the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/>
- can create.
- </value>
- </member>
- <member name="T:NAnt.Core.DataTypeBaseBuilderCollection">
- <summary>
- Contains a strongly typed collection of <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> objects.
- </summary>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.#ctor(NAnt.Core.DataTypeBaseBuilderCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/> class
- with the specified <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.#ctor(NAnt.Core.DataTypeBaseBuilder[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/> class
- with the specified array of <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.Add(NAnt.Core.DataTypeBaseBuilder)">
- <summary>
- Adds a <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.AddRange(NAnt.Core.DataTypeBaseBuilder[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.AddRange(NAnt.Core.DataTypeBaseBuilderCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.Contains(NAnt.Core.DataTypeBaseBuilder)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.Contains(System.String)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> for the specified
- task is in the collection.
- </summary>
- <param name="taskName">The name of task for which the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> should be located in the collection.</param>
- <returns>
- <see langword="true"/> if a <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> for
- the specified task is found in the collection; otherwise,
- <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.CopyTo(NAnt.Core.DataTypeBaseBuilder[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.IndexOf(NAnt.Core.DataTypeBaseBuilder)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.Core.DataTypeBaseBuilder"/>. If the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.Insert(System.Int32,NAnt.Core.DataTypeBaseBuilder)">
- <summary>
- Inserts a <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> to insert.</param>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.Core.DataTypeBaseBuilderEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.Remove(NAnt.Core.DataTypeBaseBuilder)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.Core.DataTypeBaseBuilderCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="P:NAnt.Core.DataTypeBaseBuilderCollection.Item(System.String)">
- <summary>
- Gets the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> for the specified task.
- </summary>
- <param name="dataTypeName">The name of task for which the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> should be located in the collection.</param>
- </member>
- <member name="T:NAnt.Core.DataTypeBaseBuilderEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> elements of a <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseBuilderEnumerator.#ctor(NAnt.Core.DataTypeBaseBuilderCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.DataTypeBaseBuilderEnumerator"/> class
- with the specified <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseBuilderEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseBuilderEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.Core.DataTypeBaseBuilderEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseDictionary.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.DataTypeBaseDictionary"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseDictionary.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.DataTypeBaseDictionary"/> class
- with the specified capacity.
- </summary>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseDictionary.Inherit(NAnt.Core.DataTypeBaseDictionary)">
- <summary>
- Inherits Properties from an existing property
- dictionary Instance
- </summary>
- <param name="source">DataType list to inherit</param>
- </member>
- <member name="T:NAnt.Core.DirectoryScanner">
- <summary>
- Used for searching filesystem based on given include/exclude rules.
- </summary>
- <example>
- <para>Simple client code for testing the class.</para>
- <code>
- while (true) {
- DirectoryScanner scanner = new DirectoryScanner();
-
- Console.Write("Scan Basedirectory : ");
- string s = Console.ReadLine();
- if (s.Length == 0) break;
- scanner.BaseDirectory = s;
-
- while(true) {
- Console.Write("Include pattern : ");
- s = Console.ReadLine();
- if (s.Length == 0) break;
- scanner.Includes.Add(s);
- }
-
- while(true) {
- Console.Write("Exclude pattern : ");
- s = Console.ReadLine();
- if (s.Length == 0) break;
- scanner.Excludes.Add(s);
- }
-
- foreach (string name in scanner.FileNames)
- Console.WriteLine("file:" + name);
- foreach (string name in scanner.DirectoryNames)
- Console.WriteLine("dir :" + name);
-
- Console.WriteLine("");
- }
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.DirectoryScanner.Clone">
- <summary>
- Creates a shallow copy of the <see cref="T:NAnt.Core.DirectoryScanner"/>.
- </summary>
- <returns>
- A shallow copy of the <see cref="T:NAnt.Core.DirectoryScanner"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.DirectoryScanner.Scan">
- <summary>
- Uses <see cref="P:NAnt.Core.DirectoryScanner.Includes"/> and <see cref="P:NAnt.Core.DirectoryScanner.Excludes"/> search criteria (relative to
- <see cref="P:NAnt.Core.DirectoryScanner.BaseDirectory"/> or absolute), to search for filesystem objects.
- </summary>
- </member>
- <member name="M:NAnt.Core.DirectoryScanner.ConvertPatterns(System.Collections.Specialized.StringCollection,System.Collections.ArrayList,System.Collections.Specialized.StringCollection,System.Boolean)">
- <summary>
- Parses specified NAnt search patterns for search directories and
- corresponding regex patterns.
- </summary>
- <param name="nantPatterns">In. NAnt patterns. Absolute or relative paths.</param>
- <param name="regexPatterns">Out. Regex patterns. Absolute canonical paths.</param>
- <param name="nonRegexFiles">Out. Non-regex files. Absolute canonical paths.</param>
- <param name="addSearchDirectories">In. Whether to allow a pattern to add search directories.</param>
- </member>
- <member name="M:NAnt.Core.DirectoryScanner.ParseSearchDirectoryAndPattern(System.Boolean,System.String,System.String@,System.Boolean@,System.Boolean@,System.String@)">
- <summary>
- Given a NAnt search pattern returns a search directory and an regex
- search pattern.
- </summary>
- <param name="isInclude">Whether this pattern is an include or exclude pattern</param>
- <param name="originalNAntPattern">NAnt searh pattern (relative to the Basedirectory OR absolute, relative paths refering to parent directories ( ../ ) also supported)</param>
- <param name="searchDirectory">Out. Absolute canonical path to the directory to be searched</param>
- <param name="recursive">Out. Whether the pattern is potentially recursive or not</param>
- <param name="isRegex">Out. Whether this is a regex pattern or not</param>
- <param name="regexPattern">Out. Regex search pattern (absolute canonical path)</param>
- </member>
- <member name="M:NAnt.Core.DirectoryScanner.ScanDirectory(System.String,System.Boolean)">
- <summary>
- Searches a directory recursively for files and directories matching
- the search criteria.
- </summary>
- <param name="path">Directory in which to search (absolute canonical path)</param>
- <param name="recursive">Whether to scan recursively or not</param>
- </member>
- <member name="M:NAnt.Core.DirectoryScanner.ToRegexPattern(System.String)">
- <summary>
- Converts search pattern to a regular expression pattern.
- </summary>
- <param name="nantPattern">Search pattern relative to the search directory.</param>
- <returns>Regular expresssion</returns>
- </member>
- <member name="P:NAnt.Core.DirectoryScanner.Includes">
- <summary>
- Gets the collection of include patterns.
- </summary>
- </member>
- <member name="P:NAnt.Core.DirectoryScanner.Excludes">
- <summary>
- Gets the collection of exclude patterns.
- </summary>
- </member>
- <member name="P:NAnt.Core.DirectoryScanner.BaseDirectory">
- <summary>
- The base directory to scan. The default is the
- <see cref="P:System.Environment.CurrentDirectory">current directory</see>.
- </summary>
- </member>
- <member name="P:NAnt.Core.DirectoryScanner.FileNames">
- <summary>
- Gets the list of files that match the given patterns.
- </summary>
- </member>
- <member name="P:NAnt.Core.DirectoryScanner.DirectoryNames">
- <summary>
- Gets the list of directories that match the given patterns.
- </summary>
- </member>
- <member name="P:NAnt.Core.DirectoryScanner.ScannedDirectories">
- <summary>
- Gets the list of directories that were scanned for files.
- </summary>
- </member>
- <member name="M:NAnt.Core.StringCollectionWithGoodToString.Clone">
- <summary>
- Creates a shallow copy of the <see cref="T:NAnt.Core.StringCollectionWithGoodToString"/>.
- </summary>
- <returns>
- A shallow copy of the <see cref="T:NAnt.Core.StringCollectionWithGoodToString"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.StringCollectionWithGoodToString.ToString">
- <summary>
- Creates a string representing a list of the strings in the collection.
- </summary>
- <returns>
- A string that represents the contents.
- </returns>
- </member>
- <member name="M:NAnt.Core.DirScannerStringCollection.Clone">
- <summary>
- Creates a shallow copy of the <see cref="T:NAnt.Core.DirScannerStringCollection"/>.
- </summary>
- <returns>
- A shallow copy of the <see cref="T:NAnt.Core.DirScannerStringCollection"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.DirScannerStringCollection.Contains(System.String)">
- <summary>
- Determines whether the specified string is in the
- <see cref="T:NAnt.Core.DirScannerStringCollection"/>.
- </summary>
- <param name="value">The string to locate in the <see cref="T:NAnt.Core.DirScannerStringCollection"/>. The value can be <see langword="null"/>.</param>
- <returns>
- <seee langword="true"/> if value is found in the <see cref="T:NAnt.Core.DirScannerStringCollection"/>; otherwise, <see langword="false"/>.
- </returns>
- <remarks>
- String comparisons within the <see cref="T:NAnt.Core.DirScannerStringCollection"/>
- are only case-sensitive if the filesystem on which <paramref name="value"/>
- is located, is case-sensitive.
- </remarks>
- </member>
- <member name="M:NAnt.Core.DirScannerStringCollection.IndexOf(System.String)">
- <summary>
- Searches for the specified string and returns the zero-based index
- of the first occurrence within the <see cref="T:NAnt.Core.DirScannerStringCollection"/>.
- </summary>
- <param name="value">The string to locate. The value can be <see langword="null"/>.</param>
- <returns>
- The zero-based index of the first occurrence of <paramref name="value"/>
- in the <see cref="T:NAnt.Core.DirScannerStringCollection"/>, if found; otherwise, -1.
- </returns>
- <remarks>
- String comparisons within the <see cref="T:NAnt.Core.DirScannerStringCollection"/>
- are only case-sensitive if the filesystem on which <paramref name="value"/>
- is located, is case-sensitive.
- </remarks>
- </member>
- <member name="M:NAnt.Core.DirScannerStringCollection.IsCaseSensitiveFileSystem(System.String)">
- <summary>
- Determines whether the filesystem on which the specified path is
- located is case-sensitive.
- </summary>
- <param name="path">The path of which should be determined whether its on a case-sensitive filesystem.</param>
- <returns>
- <see langword="true" /> if <paramref name="path" /> is located on a
- case-sensitive filesystem; otherwise, <see langword="false" />.
- </returns>
- </member>
- <member name="M:NAnt.Core.ExpressionEvaluator.GetPropertyValue(System.String)">
- <summary>
- Gets the value of the specified property.
- </summary>
- <param name="propertyName">The name of the property to get the value of.</param>
- <returns>
- The value of the specified property.
- </returns>
- </member>
- <member name="T:NAnt.Core.ExpressionTokenizer">
- <summary>
- Splits an input string into a sequence of tokens used during parsing.
- </summary>
- </member>
- <member name="T:NAnt.Core.ExpressionTokenizer.TokenType">
- <summary>
- Available tokens
- </summary>
- </member>
- <member name="T:NAnt.Core.FrameworkInfo">
- <summary>
- Encalsulates information about installed frameworks incuding version
- information and directory locations for finding tools.
- </summary>
- </member>
- <member name="M:NAnt.Core.FrameworkInfo.#ctor(System.String,System.String,System.String,System.Version,System.Version,System.String,System.String,System.String,System.String,NAnt.Core.Project)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.FrameworkInfo"/> class
- with a name, description, version, runtime engine, directory information
- and properties.
- </summary>
- <param name="name">The name of the framework.</param>
- <param name="family">The family of the framework.</param>
- <param name="description">The description of the framework.</param>
- <param name="version">The version number of the framework.</param>
- <param name="clrVersion">The Common Language Runtime version of the framework.</param>
- <param name="frameworkDir">The directory of the framework.</param>
- <param name="sdkDir">The directory containing the SDK tools for the framework, if available.</param>
- <param name="frameworkAssemblyDir">The directory containing the system assemblies for the framework.</param>
- <param name="runtimeEngine">The name of the runtime engine, if required.</param>
- <param name="project">The <see cref="P:NAnt.Core.FrameworkInfo.Project"/> used to initialized the framework.</param>
- </member>
- <member name="P:NAnt.Core.FrameworkInfo.Name">
- <summary>
- Gets the name of the framework.
- </summary>
- <value>
- The name of the framework.
- </value>
- </member>
- <member name="P:NAnt.Core.FrameworkInfo.Family">
- <summary>
- Gets the family of the framework.
- </summary>
- <value>
- The family of the framework.
- </value>
- </member>
- <member name="P:NAnt.Core.FrameworkInfo.Description">
- <summary>
- Gets the description of the framework.
- </summary>
- <value>
- The description of the framework.
- </value>
- </member>
- <member name="P:NAnt.Core.FrameworkInfo.Version">
- <summary>
- Gets the version of the framework.
- </summary>
- <value>
- The version of the framework.
- </value>
- </member>
- <member name="P:NAnt.Core.FrameworkInfo.ClrVersion">
- <summary>
- Gets the Common Language Runtime of the framework.
- </summary>
- <value>
- The Common Language Runtime of the framework.
- </value>
- </member>
- <member name="P:NAnt.Core.FrameworkInfo.VisualStudioVersion">
- <summary>
- Gets the Visual Studio version that corresponds with this
- framework.
- </summary>
- <remarks>
- The Visual Studio version that corresponds with this framework.
- </remarks>
- <exception cref="T:NAnt.Core.BuildException">There is no version of Visual Studio .NET that corresponds with this framework.</exception>
- </member>
- <member name="P:NAnt.Core.FrameworkInfo.FrameworkDirectory">
- <summary>
- Gets the base directory of the framework tools for the framework.
- </summary>
- <value>
- The base directory of the framework tools for the framework.
- </value>
- </member>
- <member name="P:NAnt.Core.FrameworkInfo.RuntimeEngine">
- <summary>
- Gets the path to the runtime engine for this framework.
- </summary>
- <value>
- The path to the runtime engine for the framework or <see langword="null" />
- if no runtime engine is configured for the framework.
- </value>
- </member>
- <member name="P:NAnt.Core.FrameworkInfo.FrameworkAssemblyDirectory">
- <summary>
- Gets the directory where the system assemblies for the framework
- are located.
- </summary>
- <value>
- The directory where the system assemblies for the framework are
- located.
- </value>
- </member>
- <member name="P:NAnt.Core.FrameworkInfo.SdkDirectory">
- <summary>
- Gets the directory containing the SDK tools for the framework.
- </summary>
- <value>
- The directory containing the SDK tools for the framework or a null
- refererence if the sdk directory
- </value>
- </member>
- <member name="P:NAnt.Core.FrameworkInfo.Project">
- <summary>
- Gets the <see cref="P:NAnt.Core.FrameworkInfo.Project"/> used to initialize this framework.
- </summary>
- <value>
- The <see cref="P:NAnt.Core.FrameworkInfo.Project"/> used to initialize this framework.
- </value>
- </member>
- <member name="P:NAnt.Core.FrameworkInfo.EnvironmentVariables">
- <summary>
- Gets or sets the collection of environment variables that should be
- passed to external programs that are launched in the runtime engine
- of the current framework.
- </summary>
- <value>
- The collection of environment variables that should be passed to
- external programs that are launched in the runtime engine of the
- current framework.
- </value>
- </member>
- <member name="P:NAnt.Core.FrameworkInfo.TaskAssemblies">
- <summary>
- Gets the set of assemblies and directories that should scanned for
- NAnt tasks, types or functions.
- </summary>
- <value>
- The set of assemblies and directories that should be scanned for
- NAnt tasks, types or functions.
- </value>
- </member>
- <member name="M:NAnt.Core.FrameworkInfoDictionary.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.FrameworkInfoDictionary"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.FrameworkInfoDictionary.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.FrameworkInfoDictionary"/> class
- with the specified capacity.
- </summary>
- </member>
- <member name="T:NAnt.Core.Location">
- <summary>
- Stores the file name, line number and column number to record a position
- in a text file.
- </summary>
- </member>
- <member name="M:NAnt.Core.Location.#ctor(System.String,System.Int32,System.Int32)">
- <summary>
- Creates a location consisting of a file name, line number and
- column number.
- </summary>
- <remarks>
- <paramref name="fileName" /> can be a local URI resource, e.g., file:///C:/WINDOWS/setuplog.txt.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Location.#ctor(System.String)">
- <summary>
- Creates a location consisting of a file name.
- </summary>
- <remarks>
- <paramref name="fileName" /> can be a local URI resource, e.g., file:///C:/WINDOWS/setuplog.txt.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Location.#ctor">
- <summary>
- Creates an "unknown" location.
- </summary>
- </member>
- <member name="M:NAnt.Core.Location.Init(System.String,System.Int32,System.Int32)">
- <summary>Private Init function.</summary>
- </member>
- <member name="M:NAnt.Core.Location.ToString">
- <summary>
- Returns the file name, line number and a trailing space. An error
- message can be appended easily. For unknown locations, returns
- an empty string.
- </summary>
- </member>
- <member name="P:NAnt.Core.Location.FileName">
- <summary>
- Gets a string containing the file name for the location.
- </summary>
- <remarks>
- The file name includes both the file path and the extension.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Location.LineNumber">
- <summary>
- Gets the line number for the location.
- </summary>
- <remarks>
- Lines start at 1. Will be zero if not specified.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Location.ColumnNumber">
- <summary>
- Gets the column number for the location.
- </summary>
- <remarks>
- Columns start a 1. Will be zero if not specified.
- </remarks>
- </member>
- <member name="T:NAnt.Core.LocationMap">
- <summary>
- Maps XML nodes to the text positions from their original source.
- </summary>
- </member>
- <member name="M:NAnt.Core.LocationMap.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.LocationMap"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.LocationMap.FileIsMapped(System.String)">
- <summary>
- Determines if a file has been loaded by the current project.
- </summary>
- <param name="fileOrUri">The file to check.</param>
- <returns>
- <see langword="true" /> if the specified file has already been loaded
- by the current project; otherwise, <see langword="false" />.
- </returns>
- </member>
- <member name="M:NAnt.Core.LocationMap.Add(System.Xml.XmlDocument)">
- <summary>
- Adds an <see cref="T:System.Xml.XmlDocument"/> to the map.
- </summary>
- <remarks>
- An <see cref="T:System.Xml.XmlDocument"/> can only be added to the map once.
- </remarks>
- </member>
- <member name="M:NAnt.Core.LocationMap.GetLocation(System.Xml.XmlNode)">
- <summary>
- Returns the <see cref="T:NAnt.Core.Location"/> in the XML file for the given node.
- </summary>
- <remarks>
- The <paramref name="node"/> must be from an <see cref="T:System.Xml.XmlDocument"/>
- that has been added to the map.
- </remarks>
- </member>
- <member name="T:NAnt.Core.LocationMap.TextPosition">
- <summary>
- Represents a position in the build file.
- </summary>
- </member>
- <member name="M:NAnt.Core.LocationMap.TextPosition.#ctor(System.Int32,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.LocationMap.TextPosition"/>
- with the speified line and column.
- </summary>
- <param name="line">The line coordinate of the position.</param>
- <param name="column">The column coordinate of the position.</param>
- </member>
- <member name="F:NAnt.Core.LocationMap.TextPosition.Line">
- <summary>
- The line coordinate of the position.
- </summary>
- </member>
- <member name="F:NAnt.Core.LocationMap.TextPosition.Column">
- <summary>
- The column coordinate of the position.
- </summary>
- </member>
- <member name="T:NAnt.Core.Level">
- <summary>
- Defines the set of levels recognised by the NAnt logging system.
- </summary>
- </member>
- <member name="F:NAnt.Core.Level.Debug">
- <summary>
- Designates fine-grained informational events that are most useful
- to debug a build process.
- </summary>
- </member>
- <member name="F:NAnt.Core.Level.Verbose">
- <summary>
- Designates events that offer a more detailed view of the build
- process.
- </summary>
- </member>
- <member name="F:NAnt.Core.Level.Info">
- <summary>
- Designates informational events that are useful for getting a
- high-level view of the build process.
- </summary>
- </member>
- <member name="F:NAnt.Core.Level.Warning">
- <summary>
- Designates potentionally harmful events.
- </summary>
- </member>
- <member name="F:NAnt.Core.Level.Error">
- <summary>
- Designates error events.
- </summary>
- </member>
- <member name="F:NAnt.Core.Level.None">
- <summary>
- Can be used to suppress all messages.
- </summary>
- <remarks>
- No events should be logged with this <see cref="T:NAnt.Core.Level"/>.
- </remarks>
- </member>
- <member name="T:NAnt.Core.BuildEventArgs">
- <summary>
- Class representing an event occurring during a build.
- </summary>
- <remarks>
- <para>
- An event is built by specifying either a project, a task or a target.
- </para>
- <para>
- A <see cref="P:NAnt.Core.BuildEventArgs.Project"/> level event will only have a <see cref="P:NAnt.Core.BuildEventArgs.Project"/>
- reference.
- </para>
- <para>
- A <see cref="P:NAnt.Core.BuildEventArgs.Target"/> level event will have <see cref="P:NAnt.Core.BuildEventArgs.Project"/> and
- <see cref="P:NAnt.Core.BuildEventArgs.Target"/> references.
- </para>
- <para>
- A <see cref="P:NAnt.Core.BuildEventArgs.Task"/> level event will have <see cref="P:NAnt.Core.BuildEventArgs.Project"/>,
- <see cref="P:NAnt.Core.BuildEventArgs.Target"/> and <see cref="P:NAnt.Core.BuildEventArgs.Task"/> references.
- </para>
- </remarks>
- </member>
- <member name="M:NAnt.Core.BuildEventArgs.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.BuildEventArgs"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.Core.BuildEventArgs.#ctor(NAnt.Core.Project)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.BuildEventArgs"/>
- class for a <see cref="P:NAnt.Core.BuildEventArgs.Project"/> level event.
- </summary>
- <param name="project">The <see cref="P:NAnt.Core.BuildEventArgs.Project"/> that emitted the event.</param>
- </member>
- <member name="M:NAnt.Core.BuildEventArgs.#ctor(NAnt.Core.Target)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.BuildEventArgs"/>
- class for a <see cref="P:NAnt.Core.BuildEventArgs.Target"/> level event.
- </summary>
- <param name="target">The <see cref="P:NAnt.Core.BuildEventArgs.Target"/> that emitted the event.</param>
- </member>
- <member name="M:NAnt.Core.BuildEventArgs.#ctor(NAnt.Core.Task)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.BuildEventArgs"/>
- class for a <see cref="P:NAnt.Core.BuildEventArgs.Task"/> level event.
- </summary>
- <param name="task">The <see cref="P:NAnt.Core.BuildEventArgs.Task"/> that emitted the event.</param>
- </member>
- <member name="P:NAnt.Core.BuildEventArgs.Message">
- <summary>
- Gets or sets the message associated with this event.
- </summary>
- <value>
- The message associated with this event.
- </value>
- </member>
- <member name="P:NAnt.Core.BuildEventArgs.MessageLevel">
- <summary>
- Gets or sets the priority level associated with this event.
- </summary>
- <value>
- The priority level associated with this event.
- </value>
- </member>
- <member name="P:NAnt.Core.BuildEventArgs.Exception">
- <summary>
- Gets or sets the <see cref="P:NAnt.Core.BuildEventArgs.Exception"/> associated with this event.
- </summary>
- <value>
- The <see cref="P:NAnt.Core.BuildEventArgs.Exception"/> associated with this event.
- </value>
- </member>
- <member name="P:NAnt.Core.BuildEventArgs.Project">
- <summary>
- Gets the <see cref="P:NAnt.Core.BuildEventArgs.Project"/> that fired this event.
- </summary>
- <value>
- The <see cref="P:NAnt.Core.BuildEventArgs.Project"/> that fired this event.
- </value>
- </member>
- <member name="P:NAnt.Core.BuildEventArgs.Target">
- <summary>
- Gets the <see cref="P:NAnt.Core.BuildEventArgs.Target"/> that fired this event.
- </summary>
- <value>
- The <see cref="P:NAnt.Core.BuildEventArgs.Target"/> that fired this event, or a null reference
- if this is a <see cref="P:NAnt.Core.BuildEventArgs.Project"/> level event.
- </value>
- </member>
- <member name="P:NAnt.Core.BuildEventArgs.Task">
- <summary>
- Gets the <see cref="P:NAnt.Core.BuildEventArgs.Task"/> that fired this event.
- </summary>
- <value>
- The <see cref="P:NAnt.Core.BuildEventArgs.Task"/> that fired this event, or <see langword="null"/>
- if this is a <see cref="P:NAnt.Core.BuildEventArgs.Project"/> or <see cref="P:NAnt.Core.BuildEventArgs.Target"/> level
- event.
- </value>
- </member>
- <member name="T:NAnt.Core.BuildEventHandler">
- <summary>
- Represents the method that handles the build events.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
- </member>
- <member name="T:NAnt.Core.IBuildListener">
- <summary>
- Instances of classes that implement this interface can register to be
- notified when things happen during a build.
- </summary>
- </member>
- <member name="M:NAnt.Core.IBuildListener.BuildStarted(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a build has started.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- <remarks>
- This event is fired before any targets have started.
- </remarks>
- </member>
- <member name="M:NAnt.Core.IBuildListener.BuildFinished(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that the last target has finished.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- <remarks>
- This event will still be fired if an error occurred during the build.
- </remarks>
- </member>
- <member name="M:NAnt.Core.IBuildListener.TargetStarted(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a target has started.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- </member>
- <member name="M:NAnt.Core.IBuildListener.TargetFinished(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a target has finished.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- <remarks>
- This event will still be fired if an error occurred during the build.
- </remarks>
- </member>
- <member name="M:NAnt.Core.IBuildListener.TaskStarted(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a task has started.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- </member>
- <member name="M:NAnt.Core.IBuildListener.TaskFinished(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a task has finished.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- <remarks>
- This event will still be fired if an error occurred during the build.
- </remarks>
- </member>
- <member name="M:NAnt.Core.IBuildListener.MessageLogged(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a message has been logged.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- </member>
- <member name="T:NAnt.Core.IBuildLogger">
- <summary>
- Interface used by NAnt to log the build output.
- </summary>
- <remarks>
- Depending on the supplied command-line arguments, NAnt will set the
- <see cref="P:NAnt.Core.IBuildLogger.OutputWriter"/> to <see cref="P:System.Console.Out"/> or a
- <see cref="T:System.IO.StreamWriter"/> with a file as backend store.
- </remarks>
- </member>
- <member name="M:NAnt.Core.IBuildLogger.Flush">
- <summary>
- Flushes buffered build events or messages to the underlying storage.
- </summary>
- </member>
- <member name="P:NAnt.Core.IBuildLogger.Threshold">
- <summary>
- Gets or sets the highest level of message this logger should respond
- to.
- </summary>
- <value>The highest level of message this logger should respond to.</value>
- <remarks>
- Only messages with a message level higher than or equal to the given
- level should actually be written to the log.
- </remarks>
- </member>
- <member name="P:NAnt.Core.IBuildLogger.EmacsMode">
- <summary>
- Gets or sets a value indicating whether to produce emacs (and other
- editor) friendly output.
- </summary>
- <value>
- <see langword="true" /> if output is to be unadorned so that emacs
- and other editors can parse files names, etc.
- </value>
- </member>
- <member name="P:NAnt.Core.IBuildLogger.OutputWriter">
- <summary>
- Gets or sets the <see cref="T:System.IO.TextWriter"/> to which the logger is
- to send its output.
- </summary>
- </member>
- <member name="M:NAnt.Core.DefaultLogger.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.DefaultLogger"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.Core.DefaultLogger.Flush">
- <summary>
- Flushes buffered build events or messages to the underlying storage.
- </summary>
- </member>
- <member name="M:NAnt.Core.DefaultLogger.BuildStarted(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a build has started.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- <remarks>
- This event is fired before any targets have started.
- </remarks>
- </member>
- <member name="M:NAnt.Core.DefaultLogger.BuildFinished(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that the last target has finished.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- <remarks>
- This event will still be fired if an error occurred during the build.
- </remarks>
- </member>
- <member name="M:NAnt.Core.DefaultLogger.TargetStarted(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a target has started.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- </member>
- <member name="M:NAnt.Core.DefaultLogger.TargetFinished(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a task has finished.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- <remarks>
- This event will still be fired if an error occurred during the build.
- </remarks>
- </member>
- <member name="M:NAnt.Core.DefaultLogger.TaskStarted(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a task has started.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- </member>
- <member name="M:NAnt.Core.DefaultLogger.TaskFinished(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a task has finished.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- <remarks>
- This event will still be fired if an error occurred during the build.
- </remarks>
- </member>
- <member name="M:NAnt.Core.DefaultLogger.MessageLogged(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a message has been logged.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- <remarks>
- Only messages with a priority higher or equal to the threshold of
- the logger will actually be output in the build log.
- </remarks>
- </member>
- <member name="M:NAnt.Core.DefaultLogger.Log(System.String)">
- <summary>
- Empty implementation which allows derived classes to receive the
- output that is generated in this logger.
- </summary>
- <param name="message">The message being logged.</param>
- </member>
- <member name="M:NAnt.Core.DefaultLogger.OutputMessage(NAnt.Core.Level,System.String,System.Int32)">
- <summary>
- Outputs an indented message to the build log if its priority is
- greather than or equal to the <see cref="P:NAnt.Core.DefaultLogger.Threshold"/> of the
- logger.
- </summary>
- <param name="messageLevel">The priority of the message to output.</param>
- <param name="message">The message to output.</param>
- <param name="indentationLength">The number of characters that the message should be indented.</param>
- </member>
- <member name="M:NAnt.Core.DefaultLogger.OutputMessage(NAnt.Core.BuildEventArgs)">
- <summary>
- Outputs an indented message to the build log if its priority is
- greather than or equal to the <see cref="P:NAnt.Core.DefaultLogger.Threshold"/> of the
- logger.
- </summary>
- <param name="e">The event to output.</param>
- </member>
- <member name="M:NAnt.Core.DefaultLogger.OutputMessage(NAnt.Core.BuildEventArgs,System.Int32)">
- <summary>
- Outputs an indented message to the build log if its priority is
- greather than or equal to the <see cref="P:NAnt.Core.DefaultLogger.Threshold"/> of the
- logger.
- </summary>
- <param name="e">The event to output.</param>
- <param name="indentationLength">TODO</param>
- </member>
- <member name="F:NAnt.Core.DefaultLogger._buildReports">
- <summary>
- Holds a stack of reports for all running builds.
- </summary>
- </member>
- <member name="P:NAnt.Core.DefaultLogger.Threshold">
- <summary>
- Gets or sets the highest level of message this logger should respond
- to.
- </summary>
- <value>
- The highest level of message this logger should respond to.
- </value>
- <remarks>
- Only messages with a message level higher than or equal to the given
- level should be written to the log.
- </remarks>
- </member>
- <member name="P:NAnt.Core.DefaultLogger.EmacsMode">
- <summary>
- Gets or sets a value indicating whether to produce emacs (and other
- editor) friendly output.
- </summary>
- <value>
- <see langword="true" /> if output is to be unadorned so that emacs
- and other editors can parse files names, etc. The default is
- <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.DefaultLogger.OutputWriter">
- <summary>
- Gets or sets the <see cref="T:System.IO.TextWriter"/> to which the logger is
- to send its output.
- </summary>
- <value>
- The <see cref="T:System.IO.TextWriter"/> to which the logger sends its output.
- </value>
- </member>
- <member name="T:NAnt.Core.BuildReport">
- <summary>
- Used to store information about a build, to allow better reporting to
- the user.
- </summary>
- </member>
- <member name="F:NAnt.Core.BuildReport.Errors">
- <summary>
- Errors encountered so far.
- </summary>
- </member>
- <member name="F:NAnt.Core.BuildReport.Warnings">
- <summary>
- Warnings encountered so far.
- </summary>
- </member>
- <member name="F:NAnt.Core.BuildReport.StartTime">
- <summary>
- The start time of the build process.
- </summary>
- </member>
- <member name="T:NAnt.Core.MailLogger">
- <summary>
- Buffers log messages from DefaultLogger, and sends an e-mail with the
- results.
- </summary>
- <remarks>
- The following properties are used to send the mail :
- <list type="table">
- <listheader>
- <term>Property</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>MailLogger.mailhost</term>
- <description>Mail server to use. [default: localhost]</description>
- </item>
- <item>
- <term>MailLogger.from</term>
- <description>The address of the e-mail sender.</description>
- </item>
- <item>
- <term>MailLogger.failure.notify</term>
- <description>Send build failure e-mails ? [default: true]</description>
- </item>
- <item>
- <term>MailLogger.success.notify</term>
- <description>Send build success e-mails ? [default: true]</description>
- </item>
- <item>
- <term>MailLogger.failure.to</term>
- <description>The address to send build failure messages to.</description>
- </item>
- <item>
- <term>MailLogger.success.to</term>
- <description>The address to send build success messages to.</description>
- </item>
- <item>
- <term>MailLogger.failure.subject</term>
- <description>The subject of build failure messages. [default: "Build Failure"]</description>
- </item>
- <item>
- <term>MailLogger.success.subject</term>
- <description>The subject of build success messages. [default: "Build Success"]</description>
- </item>
- <item>
- <term>MailLogger.success.attachments</term>
- <description>The ID of a fileset holdng set of files to attach when the build is successful.</description>
- </item>
- <item>
- <term>MailLogger.failure.attachments</term>
- <description>The ID of a fileset holdng set of files to attach when the build fails.</description>
- </item>
- <item>
- <term>MailLogger.body.encoding</term>
- <description>The encoding type of the body of the e-mail message. [default: system's ANSI code page]</description>
- </item>
- <item>
- <term>MailLogger.smtp.username</term>
- <description>The name of the user to login to the SMTP server.</description>
- </item>
- <item>
- <term>MailLogger.smtp.password</term>
- <description>The password of the specified user.</description>
- </item>
- <item>
- <term>MailLogger.smtp.enablessl</term>
- <description>Specifies whether to use SSL to encrypt the connection. [default: false]</description>
- </item>
- <item>
- <term>MailLogger.smtp.port</term>
- <description>The SMTP server port to connect to. [default: 25]</description>
- </item>
- </list>
- </remarks>
- </member>
- <member name="M:NAnt.Core.MailLogger.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.MailLogger"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.Core.MailLogger.BuildStarted(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a build has started.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- <remarks>
- This event is fired before any targets have started.
- </remarks>
- </member>
- <member name="M:NAnt.Core.MailLogger.BuildFinished(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that the last target has finished, and send an e-mail with
- the build results.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- </member>
- <member name="M:NAnt.Core.MailLogger.Log(System.String)">
- <summary>
- Receives and buffers log messages.
- </summary>
- <param name="message">The message being logged.</param>
- </member>
- <member name="M:NAnt.Core.MailLogger.GetPropertyValue(NAnt.Core.PropertyDictionary,System.String,System.String,System.Boolean)">
- <summary>
- Gets the value of the specified property.
- </summary>
- <param name="properties">Properties to obtain value from.</param>
- <param name="name">Suffix of property name. "MailLogger" will be prepended internally.</param>
- <param name="defaultValue">Value returned if property is not present in <paramref name="properties"/>.</param>
- <param name="required">Value indicating whether the property should exist, or have a default value set.</param>
- <returns>
- The value of the specified property; or the default value if the
- property is not present in <paramref name="properties"/>.
- </returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="required"/> is <see langword="true"/>, and the specified property is not present and no default value has been given.</exception>
- </member>
- <member name="F:NAnt.Core.MailLogger._buffer">
- <summary>
- Buffer in which the message is constructed prior to sending.
- </summary>
- </member>
- <member name="F:NAnt.Core.MailLogger._projectStack">
- <summary>
- Holds the stack of currently executing projects.
- </summary>
- </member>
- <member name="T:NAnt.Core.BuildListenerCollection">
- <summary>
- Contains a strongly typed collection of <see cref="T:NAnt.Core.IBuildListener"/>
- objects.
- </summary>
- </member>
- <member name="M:NAnt.Core.BuildListenerCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.BuildListenerCollection"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.Core.BuildListenerCollection.#ctor(NAnt.Core.BuildListenerCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.BuildListenerCollection"/>
- class with the specified <see cref="T:NAnt.Core.BuildListenerCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.Core.BuildListenerCollection.#ctor(NAnt.Core.IBuildListener[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.BuildListenerCollection"/>
- class with the specified array of <see cref="T:NAnt.Core.IBuildListener"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.Core.BuildListenerCollection.Add(NAnt.Core.IBuildListener)">
- <summary>
- Adds a <see cref="T:NAnt.Core.IBuildListener"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.IBuildListener"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.Core.BuildListenerCollection.AddRange(NAnt.Core.IBuildListener[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.IBuildListener"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.Core.IBuildListener"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.BuildListenerCollection.AddRange(NAnt.Core.BuildListenerCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.BuildListenerCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.Core.BuildListenerCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.BuildListenerCollection.Contains(NAnt.Core.IBuildListener)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.IBuildListener"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.IBuildListener"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.BuildListenerCollection.CopyTo(NAnt.Core.IBuildListener[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.Core.BuildListenerCollection.IndexOf(NAnt.Core.IBuildListener)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.Core.IBuildListener"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.IBuildListener"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.Core.IBuildListener"/>. If the <see cref="T:NAnt.Core.IBuildListener"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.Core.BuildListenerCollection.Insert(System.Int32,NAnt.Core.IBuildListener)">
- <summary>
- Inserts a <see cref="T:NAnt.Core.IBuildListener"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.Core.IBuildListener"/> to insert.</param>
- </member>
- <member name="M:NAnt.Core.BuildListenerCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.Core.BuildListenerEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.BuildListenerCollection.Remove(NAnt.Core.IBuildListener)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.IBuildListener"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.Core.BuildListenerCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="T:NAnt.Core.BuildListenerEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.Core.IBuildListener"/> elements of a <see cref="T:NAnt.Core.BuildListenerCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.BuildListenerEnumerator.#ctor(NAnt.Core.BuildListenerCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.BuildListenerEnumerator"/> class
- with the specified <see cref="T:NAnt.Core.BuildListenerCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.Core.BuildListenerEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.BuildListenerEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.Core.BuildListenerEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.Core.LogWriter">
- <summary>
- Implements a <see cref="T:System.IO.TextWriter"/> for writing information to
- the NAnt logging infrastructure.
- </summary>
- </member>
- <member name="M:NAnt.Core.LogWriter.#ctor(NAnt.Core.Task,NAnt.Core.Level,System.IFormatProvider)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.LogWriter"/> class
- for the specified <see cref="T:NAnt.Core.Task"/> with the specified output
- level and format provider.
- </summary>
- <param name="task">Determines the indentation level.</param>
- <param name="outputLevel">The <see cref="T:NAnt.Core.Level"/> with which messages will be output to the build log.</param>
- <param name="formatProvider">An <see cref="T:System.IFormatProvider"/> object that controls formatting.</param>
- </member>
- <member name="M:NAnt.Core.LogWriter.Write(System.Char[])">
- <summary>
- Writes a character array to the buffer.
- </summary>
- <param name="chars">The character array to write to the text stream.</param>
- </member>
- <member name="M:NAnt.Core.LogWriter.Write(System.String)">
- <summary>
- Writes a string to the buffer.
- </summary>
- <param name="value"></param>
- </member>
- <member name="M:NAnt.Core.LogWriter.WriteLine">
- <summary>
- Writes an empty string to the logging infrastructure.
- </summary>
- </member>
- <member name="M:NAnt.Core.LogWriter.WriteLine(System.String)">
- <summary>
- Writes a string to the logging infrastructure.
- </summary>
- <param name="value">The string to write. If <paramref name="value" /> is a null reference, only the line termination characters are written.</param>
- </member>
- <member name="M:NAnt.Core.LogWriter.WriteLine(System.String,System.Object[])">
- <summary>
- Writes out a formatted string using the same semantics as
- <see cref="M:System.String.Format(System.String,System.Object[])"/>.
- </summary>
- <param name="line">The formatting string.</param>
- <param name="args">The object array to write into format string.</param>
- </member>
- <member name="M:NAnt.Core.LogWriter.Flush">
- <summary>
- Causes any buffered data to be written to the logging infrastructure.
- </summary>
- </member>
- <member name="M:NAnt.Core.LogWriter.Close">
- <summary>
- Closes the current writer and releases any system resources
- associated with the writer.
- </summary>
- </member>
- <member name="M:NAnt.Core.LogWriter.InitializeLifetimeService">
- <summary>
- Obtains a lifetime service object to control the lifetime policy for
- this instance.
- </summary>
- <returns>
- An object of type <see cref="T:System.Runtime.Remoting.Lifetime.ILease"/> used to control the lifetime
- policy for this instance. This is the current lifetime service object
- for this instance if one exists; otherwise, a new lifetime service
- object initialized with a lease that will never time out.
- </returns>
- </member>
- <member name="P:NAnt.Core.LogWriter.Encoding">
- <summary>
- Gets the <see cref="P:NAnt.Core.LogWriter.Encoding"/> in which the output is written.
- </summary>
- <value>
- The <see cref="T:NAnt.Core.LogWriter"/> always writes output in UTF8
- encoding.
- </value>
- </member>
- <member name="P:NAnt.Core.LogWriter.OutputLevel">
- <summary>
- Gets the <see cref="T:NAnt.Core.Level"/> with which messages will be output to
- the build log.
- </summary>
- </member>
- <member name="T:NAnt.Core.PathScanner">
- <summary>
- Used to search for files on the PATH.
- </summary>
- <remarks>
- <para>
- The local directory is not searched (since this would already be covered
- by normal use of the includes element).
- </para>
- <para>
- Also, advanced pattern matching isn't supported: you need to know the
- exact name of the file.
- </para>
- </remarks>
- </member>
- <member name="M:NAnt.Core.PathScanner.System#ICloneable#Clone">
- <summary>
- Creates a shallow copy of the <see cref="T:NAnt.Core.PathScanner"/>.
- </summary>
- <returns>
- A shallow copy of the <see cref="T:NAnt.Core.PathScanner"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.PathScanner.Clone">
- <summary>
- Creates a shallow copy of the <see cref="T:NAnt.Core.PathScanner"/>.
- </summary>
- <returns>
- A shallow copy of the <see cref="T:NAnt.Core.PathScanner"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.PathScanner.Add(System.String)">
- <summary>
- Adds a file to the list of files to be scanned for.
- </summary>
- <param name="fileName">The filename or search pattern to add to the list.</param>
- </member>
- <member name="M:NAnt.Core.PathScanner.Scan">
- <summary>
- Scans all direcetories in the PATH environment variable for files.
- </summary>
- <returns>
- List of matching files found in the PATH.
- </returns>
- </member>
- <member name="M:NAnt.Core.PathScanner.Scan(System.String)">
- <summary>
- Scans all directories in the given environment variable for files.
- </summary>
- <param name="name">The environment variable of which the directories should be scanned.</param>
- <returns>
- List of matching files found in the directory of the given
- environment variable.
- </returns>
- </member>
- <member name="M:NAnt.Core.PathScanner.Clone(System.Collections.Specialized.StringCollection)">
- <summary>
- Creates a shallow copy of the specified <see cref="T:System.Collections.Specialized.StringCollection"/>.
- </summary>
- <param name="stringCollection">The <see cref="T:System.Collections.Specialized.StringCollection"/> that should be copied.</param>
- <returns>
- A shallow copy of the specified <see cref="T:System.Collections.Specialized.StringCollection"/>.
- </returns>
- </member>
- <member name="T:NAnt.Core.Project">
- <summary>
- Central representation of a NAnt project.
- </summary>
- <example>
- <para>
- The <see cref="M:NAnt.Core.Project.Run"/> method will initialize the project with the build
- file specified in the constructor and execute the default target.
- </para>
- <code>
- <![CDATA[
- Project p = new Project("foo.build", Level.Info);
- p.Run();
- ]]>
- </code>
- </example>
- <example>
- <para>
- If no target is given, the default target will be executed if specified
- in the project.
- </para>
- <code>
- <![CDATA[
- Project p = new Project("foo.build", Level.Info);
- p.Execute("build");
- ]]>
- </code>
- </example>
- </member>
- <member name="F:NAnt.Core.Project.Visiting">
- <summary>
- Constant for the "visiting" state, used when traversing a DFS of
- target dependencies.
- </summary>
- </member>
- <member name="F:NAnt.Core.Project.Visited">
- <summary>
- Constant for the "visited" state, used when traversing a DFS of
- target dependencies.
- </summary>
- </member>
- <member name="F:NAnt.Core.Project.logger">
- <summary>
- Holds the logger for this class.
- </summary>
- </member>
- <member name="F:NAnt.Core.Project._threshold">
- <summary>
- Holds the default threshold for build loggers.
- </summary>
- </member>
- <member name="M:NAnt.Core.Project.#ctor(System.Xml.XmlDocument,NAnt.Core.Level,System.Int32)">
- <summary>
- Initializes a new <see cref="T:NAnt.Core.Project"/> class with the given
- document, message threshold and indentation level.
- </summary>
- <param name="doc">Any valid build format will do.</param>
- <param name="threshold">The message threshold.</param>
- <param name="indentLevel">The project indentation level.</param>
- </member>
- <member name="M:NAnt.Core.Project.#ctor(System.Xml.XmlDocument,NAnt.Core.Level,System.Int32,System.Xml.XmlNode)">
- <summary>
- Initializes a new <see cref="T:NAnt.Core.Project"/> class with the given
- document, message threshold and indentation level, and using
- the specified <see cref="T:System.Xml.XmlNode"/> to load internal configuration
- settings.
- </summary>
- <param name="doc">Any valid build format will do.</param>
- <param name="threshold">The message threshold.</param>
- <param name="indentLevel">The project indentation level.</param>
- <param name="configurationNode">The <see cref="T:System.Xml.XmlNode"/> NAnt should use to initialize configuration settings.</param>
- <remarks>
- This constructor is useful for developers using NAnt as a class
- library.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Project.#ctor(System.String,NAnt.Core.Level,System.Int32)">
- <summary>
- Initializes a new <see cref="T:NAnt.Core.Project"/> class with the given
- source, message threshold and indentation level.
- </summary>
- <param name="uriOrFilePath">
- <para>The full path to the build file.</para>
- <para>This can be of any form that <see cref="M:System.Xml.XmlDocument.Load(System.String)"/> accepts.</para>
- </param>
- <param name="threshold">The message threshold.</param>
- <param name="indentLevel">The project indentation level.</param>
- <remarks>
- If the source is a uri of form 'file:///path' then use the path part.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Project.#ctor(System.String,NAnt.Core.Level,System.Int32,System.Xml.XmlNode)">
- <summary>
- Initializes a new <see cref="T:NAnt.Core.Project"/> class with the given
- source, message threshold and indentation level, and using
- the specified <see cref="T:System.Xml.XmlNode"/> to load internal configuration
- settings.
- </summary>
- <param name="uriOrFilePath">
- <para>The full path to the build file.</para>
- <para>This can be of any form that <see cref="M:System.Xml.XmlDocument.Load(System.String)"/> accepts.</para>
- </param>
- <param name="threshold">The message threshold.</param>
- <param name="indentLevel">The project indentation level.</param>
- <param name="configurationNode">The <see cref="T:System.Xml.XmlNode"/> NAnt should use to initialize configuration settings.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="configurationNode"/> is <see langword="null"/>.</exception>
- <remarks>
- If the source is a uri of form 'file:///path' then use the path part.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Project.#ctor(System.String,NAnt.Core.Project)">
- <summary>
- Initializes a <see cref="T:NAnt.Core.Project"/> as subproject of the specified
- <see cref="T:NAnt.Core.Project"/>.
- </summary>
- <param name="uriOrFilePath">
- <para>The full path to the build file.</para>
- <para>This can be of any form that <see cref="M:System.Xml.XmlDocument.Load(System.String)"/> accepts.</para>
- </param>
- <param name="parent">The parent <see cref="T:NAnt.Core.Project"/>.</param>
- <remarks>
- Optimized for framework initialization projects, by skipping automatic
- discovery of extension assemblies and framework configuration.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Project.#ctor(System.Xml.XmlDocument)">
- <summary>
- Initializes a <see cref="T:NAnt.Core.Project"/> with <see cref="P:NAnt.Core.Project.Threshold"/>
- set to <see cref="F:NAnt.Core.Level.None"/>, and <see cref="P:NAnt.Core.Project.IndentationLevel"/>
- set to 0.
- </summary>
- <param name="doc">An <see cref="T:System.Xml.XmlDocument"/> containing the build script.</param>
- <remarks>
- Optimized for framework initialization projects, by skipping automatic
- discovery of extension assemblies and framework configuration.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Project.OnBuildStarted(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Dispatches a <see cref="F:NAnt.Core.Project.BuildStarted"/> event to the build listeners
- for this <see cref="T:NAnt.Core.Project"/>.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
- </member>
- <member name="M:NAnt.Core.Project.OnBuildFinished(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Dispatches a <see cref="F:NAnt.Core.Project.BuildFinished"/> event to the build listeners
- for this <see cref="T:NAnt.Core.Project"/>.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
- </member>
- <member name="M:NAnt.Core.Project.OnTargetStarted(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Dispatches a <see cref="F:NAnt.Core.Project.TargetStarted"/> event to the build listeners
- for this <see cref="T:NAnt.Core.Project"/>.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
- </member>
- <member name="M:NAnt.Core.Project.OnTargetFinished(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Dispatches a <see cref="F:NAnt.Core.Project.TargetFinished"/> event to the build listeners
- for this <see cref="T:NAnt.Core.Project"/>.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
- </member>
- <member name="M:NAnt.Core.Project.OnTaskStarted(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Dispatches a <see cref="F:NAnt.Core.Project.TaskStarted"/> event to the build listeners
- for this <see cref="T:NAnt.Core.Project"/>.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
- </member>
- <member name="M:NAnt.Core.Project.OnTaskFinished(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Dispatches the <see cref="F:NAnt.Core.Project.TaskFinished"/> event to the build listeners
- for this <see cref="T:NAnt.Core.Project"/>.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
- </member>
- <member name="M:NAnt.Core.Project.OnMessageLogged(NAnt.Core.BuildEventArgs)">
- <summary>
- Dispatches a <see cref="F:NAnt.Core.Project.MessageLogged"/> event to the build listeners
- for this <see cref="T:NAnt.Core.Project"/>.
- </summary>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
- </member>
- <member name="M:NAnt.Core.Project.Log(NAnt.Core.Level,System.String)">
- <summary>
- Writes a <see cref="T:NAnt.Core.Project"/> level message to the build log with
- the given <see cref="T:NAnt.Core.Level"/>.
- </summary>
- <param name="messageLevel">The <see cref="T:NAnt.Core.Level"/> to log at.</param>
- <param name="message">The message to log.</param>
- </member>
- <member name="M:NAnt.Core.Project.Log(NAnt.Core.Level,System.String,System.Object[])">
- <summary>
- Writes a <see cref="T:NAnt.Core.Project"/> level formatted message to the build
- log with the given <see cref="T:NAnt.Core.Level"/>.
- </summary>
- <param name="messageLevel">The <see cref="T:NAnt.Core.Level"/> to log at.</param>
- <param name="message">The message to log, containing zero or more format items.</param>
- <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
- </member>
- <member name="M:NAnt.Core.Project.Log(NAnt.Core.Task,NAnt.Core.Level,System.String)">
- <summary>
- Writes a <see cref="T:NAnt.Core.Task"/> task level message to the build log
- with the given <see cref="T:NAnt.Core.Level"/>.
- </summary>
- <param name="task">The <see cref="T:NAnt.Core.Task"/> from which the message originated.</param>
- <param name="messageLevel">The <see cref="T:NAnt.Core.Level"/> to log at.</param>
- <param name="message">The message to log.</param>
- </member>
- <member name="M:NAnt.Core.Project.Log(NAnt.Core.Target,NAnt.Core.Level,System.String)">
- <summary>
- Writes a <see cref="T:NAnt.Core.Target"/> level message to the build log with
- the given <see cref="T:NAnt.Core.Level"/>.
- </summary>
- <param name="target">The <see cref="T:NAnt.Core.Target"/> from which the message orignated.</param>
- <param name="messageLevel">The level to log at.</param>
- <param name="message">The message to log.</param>
- </member>
- <member name="M:NAnt.Core.Project.Execute">
- <summary>
- Executes the default target.
- </summary>
- <remarks>
- No top level error handling is done. Any <see cref="T:NAnt.Core.BuildException"/>
- will be passed onto the caller.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Project.Execute(System.String)">
- <summary>
- Executes a specific target, and its dependencies.
- </summary>
- <param name="targetName">The name of the target to execute.</param>
- <remarks>
- Global tasks are not executed.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Project.Execute(System.String,System.Boolean)">
- <summary>
- Executes a specific target.
- </summary>
- <param name="targetName">The name of the target to execute.</param>
- <param name="forceDependencies">Whether dependencies should be forced to execute</param>
- <remarks>
- Global tasks are not executed.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Project.Run">
- <summary>
- Executes the default target and wraps in error handling and time
- stamping.
- </summary>
- <returns>
- <see langword="true" /> if the build was successful; otherwise,
- <see langword="false" />.
- </returns>
- </member>
- <member name="M:NAnt.Core.Project.CreateTask(System.Xml.XmlNode)">
- <summary>
- Creates a new <see ref="Task"/> from the given <see cref="T:System.Xml.XmlNode"/>.
- </summary>
- <param name="taskNode">The <see cref="T:NAnt.Core.Task"/> definition.</param>
- <returns>The new <see cref="T:NAnt.Core.Task"/> instance.</returns>
- </member>
- <member name="M:NAnt.Core.Project.CreateTask(System.Xml.XmlNode,NAnt.Core.Target)">
- <summary>
- Creates a new <see cref="T:NAnt.Core.Task"/> from the given <see cref="T:System.Xml.XmlNode"/>
- within a <see cref="T:NAnt.Core.Target"/>.
- </summary>
- <param name="taskNode">The <see cref="T:NAnt.Core.Task"/> definition.</param>
- <param name="target">The owner <see cref="T:NAnt.Core.Target"/>.</param>
- <returns>The new <see cref="T:NAnt.Core.Task"/> instance.</returns>
- </member>
- <member name="M:NAnt.Core.Project.ExpandProperties(System.String,NAnt.Core.Location)">
- <summary>
- Expands a <see cref="T:System.String"/> from known properties.
- </summary>
- <param name="input">The <see cref="T:System.String"/> with replacement tokens.</param>
- <param name="location">The location in the build file. Used to throw more accurate exceptions.</param>
- <returns>The expanded and replaced <see cref="T:System.String"/>.</returns>
- </member>
- <member name="M:NAnt.Core.Project.GetFullPath(System.String)">
- <summary>
- Combines the specified path with the <see cref="P:NAnt.Core.Project.BaseDirectory"/> of
- the <see cref="T:NAnt.Core.Project"/> to form a full path to file or directory.
- </summary>
- <param name="path">The relative or absolute path.</param>
- <returns>
- A rooted path, or the <see cref="P:NAnt.Core.Project.BaseDirectory"/> of the <see cref="T:NAnt.Core.Project"/>
- if the <paramref name="path"/> parameter is a null reference.
- </returns>
- </member>
- <member name="M:NAnt.Core.Project.CreateDefaultLogger">
- <summary>
- Creates the default <see cref="T:NAnt.Core.IBuildLogger"/> and attaches it to
- the <see cref="T:NAnt.Core.Project"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Project.Indent">
- <summary>
- Increases the <see cref="P:NAnt.Core.Project.IndentationLevel"/> of the <see cref="T:NAnt.Core.Project"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Project.Unindent">
- <summary>
- Decreases the <see cref="P:NAnt.Core.Project.IndentationLevel"/> of the <see cref="T:NAnt.Core.Project"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Project.DetachBuildListeners">
- <summary>
- Detaches the currently attached <see cref="T:NAnt.Core.IBuildListener"/> instances
- from the <see cref="T:NAnt.Core.Project"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Project.AttachBuildListeners(NAnt.Core.BuildListenerCollection)">
- <summary>
- Attaches the specified build listeners to the <see cref="T:NAnt.Core.Project"/>.
- </summary>
- <param name="listeners">The <see cref="T:NAnt.Core.IBuildListener"/> instances to attach to the <see cref="T:NAnt.Core.Project"/>.</param>
- <remarks>
- The currently attached <see cref="T:NAnt.Core.IBuildListener"/> instances will
- be detached before the new <see cref="T:NAnt.Core.IBuildListener"/> instances
- are attached.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Project.CtorHelper(System.Xml.XmlDocument,NAnt.Core.Level,System.Int32,NAnt.Core.Optimizations)">
- <summary>
- Inits stuff:
- <para>TypeFactory: Calls Initialize and AddProject </para>
- <para>Log.IndentSize set to 12</para>
- <para>Project properties are initialized ("nant.* stuff set")</para>
- <list type="nant.items">
- <listheader>NAnt Props:</listheader>
- <item>nant.filename</item>
- <item>nant.version</item>
- <item>nant.location</item>
- <item>nant.project.name</item>
- <item>nant.project.buildfile (if doc has baseuri)</item>
- <item>nant.project.basedir</item>
- <item>nant.project.default = defaultTarget</item>
- <item>nant.tasks.[name] = true</item>
- <item>nant.tasks.[name].location = AssemblyFileName</item>
- </list>
- </summary>
- <param name="doc">An <see cref="T:System.Xml.XmlDocument"/> representing the project definition.</param>
- <param name="threshold">The project message threshold.</param>
- <param name="indentLevel">The project indentation level.</param>
- <param name="optimization">Optimization flags.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="doc"/> is <see langword="null"/>.</exception>
- </member>
- <member name="M:NAnt.Core.Project.InitializeProjectDocument(System.Xml.XmlDocument)">
- <summary>
- This method is only meant to be used by the <see cref="T:NAnt.Core.Project"/>
- class and <see cref="T:NAnt.Core.Tasks.IncludeTask"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Project.LoadBuildFile(System.String)">
- <summary>
- Creates a new <see cref="T:System.Xml.XmlDocument"/> based on the project
- definition.
- </summary>
- <param name="uriOrFilePath">
- <para>The full path to the build file.</para>
- <para>This can be of any form that <see cref="M:System.Xml.XmlDocument.Load(System.String)"/> accepts.</para>
- </param>
- <returns>
- An <see cref="T:System.Xml.XmlDocument"/> based on the specified project
- definition.
- </returns>
- </member>
- <member name="M:NAnt.Core.Project.ConfigurePlatformProperties">
- <summary>
- Configures the platform properties for the current platform.
- </summary>
- <exception cref="T:NAnt.Core.BuildException">NAnt does not support the current platform.</exception>
- </member>
- <member name="M:NAnt.Core.Project.UpdateTargetFrameworkProperties">
- <summary>
- Updates dependent properties when the <see cref="P:NAnt.Core.Project.TargetFramework"/>
- is set.
- </summary>
- </member>
- <member name="M:NAnt.Core.Project.TopologicalTargetSort(System.String,NAnt.Core.TargetCollection)">
- <summary>
- Topologically sorts a set of targets.
- </summary>
- <param name="root">The name of the root target. The sort is created in such a way that the sequence of targets up to the root target is the minimum possible such sequence. Must not be <see langword="null"/>.</param>
- <param name="targets">A collection of <see cref="T:NAnt.Core.Target"/> instances.</param>
- <returns>
- A collection of <see cref="T:NAnt.Core.Target"/> instances in sorted order.
- </returns>
- <exception cref="T:NAnt.Core.BuildException">There is a cyclic dependecy among the targets, or a named target does not exist.</exception>
- </member>
- <member name="M:NAnt.Core.Project.TopologicalTargetSort(System.String,NAnt.Core.TargetCollection,System.Collections.Hashtable,System.Collections.Stack,NAnt.Core.TargetCollection)">
- <summary>
- <para>
- Performs a single step in a recursive depth-first-search traversal
- of the target dependency tree.
- </para>
- <para>
- The current target is first set to the "visiting" state, and pushed
- onto the "visiting" stack.
- </para>
- <para>
- An exception is then thrown if any child of the current node is in
- the visiting state, as that implies a circular dependency. The
- exception contains details of the cycle, using elements of the
- "visiting" stack.
- </para>
- <para>
- If any child has not already been "visited", this method is called
- recursively on it.
- </para>
- <para>
- The current target is then added to the ordered list of targets.
- Note that this is performed after the children have been visited in
- order to get the correct order. The current target is set to the
- "visited" state.
- </para>
- <para>
- By the time this method returns, the ordered list contains the
- sequence of targets up to and including the current target.
- </para>
- </summary>
- <param name="root">The current target to inspect. Must not be <see langword="null"/>.</param>
- <param name="targets">A collection of <see cref="T:NAnt.Core.Target"/> instances.</param>
- <param name="state">A mapping from targets to states The states in question are "VISITING" and "VISITED". Must not be <see langword="null"/>.</param>
- <param name="visiting">A stack of targets which are currently being visited. Must not be <see langword="null"/>.</param>
- <param name="executeTargets">The list to add target names to. This will end up containing the complete list of depenencies in dependency order. Must not be <see langword="null"/>.</param>
- <exception cref="T:NAnt.Core.BuildException">
- <para>A non-existent target is specified</para>
- <para>-or-</para>
- <para>A circular dependency is detected.</para>
- </exception>
- </member>
- <member name="M:NAnt.Core.Project.CreateCircularException(System.String,System.Collections.Stack)">
- <summary>
- Builds an appropriate exception detailing a specified circular
- dependency.
- </summary>
- <param name="end">The dependency to stop at. Must not be <see langword="null"/>.</param>
- <param name="stack">A stack of dependencies. Must not be <see langword="null"/>.</param>
- <returns>
- A <see cref="T:NAnt.Core.BuildException"/> detailing the specified circular
- dependency.
- </returns>
- </member>
- <member name="P:NAnt.Core.Project.IndentationLevel">
- <summary>
- Gets or sets the indendation level of the build output.
- </summary>
- <value>
- The indentation level of the build output.
- </value>
- <remarks>
- To change the <see cref="P:NAnt.Core.Project.IndentationLevel"/>, the <see cref="M:NAnt.Core.Project.Indent"/>
- and <see cref="M:NAnt.Core.Project.Unindent"/> methods should be used.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Project.IndentationSize">
- <summary>
- Gets or sets the indentation size of the build output.
- </summary>
- <value>
- The indendation size of the build output.
- </value>
- </member>
- <member name="P:NAnt.Core.Project.Threshold">
- <summary>
- Gets or sets the default threshold level for build loggers.
- </summary>
- <value>
- The default threshold level for build loggers.
- </value>
- </member>
- <member name="P:NAnt.Core.Project.ProjectName">
- <summary>
- Gets the name of the <see cref="T:NAnt.Core.Project"/>.
- </summary>
- <value>
- The name of the <see cref="T:NAnt.Core.Project"/> or an empty <see cref="T:System.String"/>
- if no name is specified.
- </value>
- </member>
- <member name="P:NAnt.Core.Project.BaseDirectory">
- <summary>
- Gets or sets the base directory used for relative references.
- </summary>
- <value>
- The base directory used for relative references.
- </value>
- <exception cref="T:NAnt.Core.BuildException">The directory is not rooted.</exception>
- <remarks>
- <para>
- The <see cref="P:NAnt.Core.Project.BaseDirectory"/> gets and sets the built-in property
- named "nant.project.basedir".
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Core.Project.NamespaceManager">
- <summary>
- Gets the <see cref="T:System.Xml.XmlNamespaceManager"/>.
- </summary>
- <value>
- The <see cref="T:System.Xml.XmlNamespaceManager"/>.
- </value>
- <remarks>
- The <see cref="P:NAnt.Core.Project.NamespaceManager"/> defines the current namespace
- scope and provides methods for looking up namespace information.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Project.BuildFileUri">
- <summary>
- Gets the <see cref="T:System.Uri"/> form of the current project definition.
- </summary>
- <value>
- The <see cref="T:System.Uri"/> form of the current project definition.
- </value>
- </member>
- <member name="P:NAnt.Core.Project.Frameworks">
- <summary>
- Gets a collection of available .NET frameworks.
- </summary>
- <value>
- A collection of available .NET frameworks.
- </value>
- </member>
- <member name="P:NAnt.Core.Project.RuntimeFramework">
- <summary>
- Gets the framework in which NAnt is currently running.
- </summary>
- <value>
- The framework in which NAnt is currently running.
- </value>
- </member>
- <member name="P:NAnt.Core.Project.TargetFramework">
- <summary>
- Gets or sets the framework to use for compilation.
- </summary>
- <value>
- The framework to use for compilation.
- </value>
- <remarks>
- We will use compiler tools and system assemblies for this framework
- in framework-related tasks.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Project.PlatformName">
- <summary>
- Gets the name of the platform on which NAnt is currently running.
- </summary>
- <value>
- The name of the platform on which NAnt is currently running.
- </value>
- <remarks>
- <para>
- Possible values are:
- </para>
- <list type="bullet">
- <item>
- <description>win32</description>
- </item>
- <item>
- <description>unix</description>
- </item>
- </list>
- </remarks>
- <exception cref="T:NAnt.Core.BuildException">NAnt does not support the current platform.</exception>
- </member>
- <member name="P:NAnt.Core.Project.CurrentTarget">
- <summary>
- Gets the current target.
- </summary>
- <value>
- The current target, or <see langword="null" /> if no target is
- executing.
- </value>
- </member>
- <member name="P:NAnt.Core.Project.BuildFileLocalName">
- <summary>
- Gets the path to the build file.
- </summary>
- <value>
- The path to the build file, or <see langword="null" /> if the build
- document is not file backed.
- </value>
- </member>
- <member name="P:NAnt.Core.Project.Document">
- <summary>
- Gets the active <see cref="T:NAnt.Core.Project"/> definition.
- </summary>
- <value>
- The active <see cref="T:NAnt.Core.Project"/> definition.
- </value>
- </member>
- <member name="P:NAnt.Core.Project.ConfigurationNode">
- <summary>
- Gets the <see cref="T:System.Xml.XmlNode"/> NAnt should use to initialize
- configuration settings.
- </summary>
- <value>
- The <see cref="T:System.Xml.XmlNode"/> NAnt should use to initialize
- configuration settings.
- </value>
- </member>
- <member name="P:NAnt.Core.Project.DefaultTargetName">
- <remarks>
- Gets the name of the target that will be executed when no other
- build targets are specified.
- </remarks>
- <value>
- The name of the target that will be executed when no other
- build targets are specified, or <see langword="null" /> if no
- default target is specified in the build file.
- </value>
- </member>
- <member name="P:NAnt.Core.Project.Verbose">
- <summary>
- Gets a value indicating whether tasks should output more build log
- messages.
- </summary>
- <value>
- <see langword="true" /> if tasks should output more build log message;
- otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.Project.BuildTargets">
- <summary>
- The list of targets to build.
- </summary>
- <remarks>
- Targets are built in the order they appear in the collection. If
- the collection is empty the default target will be built.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Project.Properties">
- <summary>
- Gets the properties defined in this project.
- </summary>
- <value>The properties defined in this project.</value>
- <remarks>
- <para>
- This is the collection of properties that are defined by the system
- and property task statements.
- </para>
- <para>
- These properties can be used in expansion.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Core.Project.FrameworkNeutralProperties">
- <summary>
- Gets the framework-neutral properties defined in the NAnt
- configuration file.
- </summary>
- <value>
- The framework-neutral properties defined in the NAnt configuration
- file.
- </value>
- <remarks>
- <para>
- This is the collection of read-only properties that are defined in
- the NAnt configuration file.
- </para>
- <para>
- These properties can only be used for expansion in framework-specific
- and framework-neutral configuration settings. These properties are
- not available for expansion in the build file.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Core.Project.DataTypeReferences">
- <summary>
- Gets the <see cref="T:NAnt.Core.DataTypeBase"/> instances defined in this project.
- </summary>
- <value>
- The <see cref="T:NAnt.Core.DataTypeBase"/> instances defined in this project.
- </value>
- <remarks>
- <para>
- This is the collection of <see cref="T:NAnt.Core.DataTypeBase"/> instances that
- are defined by <see cref="T:NAnt.Core.DataTypeBase"/> (eg fileset) declarations.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Core.Project.Targets">
- <summary>
- Gets the targets defined in this project.
- </summary>
- <value>
- The targets defined in this project.
- </value>
- </member>
- <member name="P:NAnt.Core.Project.BuildListeners">
- <summary>
- Gets the build listeners for this project.
- </summary>
- <value>
- The build listeners for this project.
- </value>
- </member>
- <member name="T:NAnt.Core.Optimizations">
- <summary>
- Allow the project construction to be optimized.
- </summary>
- <remarks>
- Use this with care!
- </remarks>
- </member>
- <member name="F:NAnt.Core.Optimizations.None">
- <summary>
- Do not perform any optimizations.
- </summary>
- </member>
- <member name="F:NAnt.Core.Optimizations.SkipAutomaticDiscovery">
- <summary>
- The project base directory must not be automatically scanned
- for extension assemblies.
- </summary>
- </member>
- <member name="F:NAnt.Core.Optimizations.SkipFrameworkConfiguration">
- <summary>
- Do not scan the project configuration for frameworks, and
- do not configure the runtime and target framework.
- </summary>
- </member>
- <member name="F:NAnt.Core.ProjectSettingsLoader.ScannedTasks">
- <summary>
- Holds a value indicating whether a scan for tasks, types and functions
- has already been performed for the current runtime framework.
- </summary>
- </member>
- <member name="M:NAnt.Core.ProjectSettingsLoader.#ctor(NAnt.Core.Project)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.ProjectSettingsLoader"/>
- class for the given <see cref="P:NAnt.Core.ProjectSettingsLoader.Project"/>.
- </summary>
- <param name="project">The <see cref="P:NAnt.Core.ProjectSettingsLoader.Project"/> that should be configured.</param>
- </member>
- <member name="M:NAnt.Core.ProjectSettingsLoader.ProcessSettings">
- <summary>
- Loads and processes settings from the specified <see cref="T:System.Xml.XmlNode"/>
- of the configuration file.
- </summary>
- </member>
- <member name="M:NAnt.Core.ProjectSettingsLoader.ProcessFrameworks(System.Xml.XmlNode)">
- <summary>
- Processes the framework nodes of the given platform node.
- </summary>
- <param name="platformNode">An <see cref="T:System.Xml.XmlNode"/> representing the platform on which NAnt is running.</param>
- </member>
- <member name="M:NAnt.Core.ProjectSettingsLoader.ProcessGlobalProperties(System.Xml.XmlNodeList)">
- <summary>
- Reads the list of global properties specified in the NAnt configuration
- file.
- </summary>
- <param name="propertyNodes">An <see cref="T:System.Xml.XmlNodeList"/> representing global properties.</param>
- </member>
- <member name="M:NAnt.Core.ProjectSettingsLoader.ProcessFrameworkEnvironmentVariables(System.Xml.XmlNodeList,NAnt.Core.FrameworkInfo)">
- <summary>
- Processes the framework environment variables.
- </summary>
- <param name="environmentNodes">An <see cref="T:System.Xml.XmlNodeList"/> representing framework environment variables.</param>
- <param name="framework">The <see cref="T:NAnt.Core.FrameworkInfo"/> to obtain framework-specific information from.</param>
- </member>
- <member name="M:NAnt.Core.ProjectSettingsLoader.GetXmlAttributeValue(System.Xml.XmlNode,System.String)">
- <summary>
- Gets the value of the specified attribute from the specified node.
- </summary>
- <param name="xmlNode">The node of which the attribute value should be retrieved.</param>
- <param name="attributeName">The attribute of which the value should be returned.</param>
- <returns>
- The value of the attribute with the specified name or <see langword="null" />
- if the attribute does not exist or has no value.
- </returns>
- </member>
- <member name="P:NAnt.Core.ProjectSettingsLoader.Project">
- <summary>
- Gets the underlying <see cref="P:NAnt.Core.ProjectSettingsLoader.Project"/> instance.
- </summary>
- <value>
- The underlying <see cref="P:NAnt.Core.ProjectSettingsLoader.Project"/> instance.
- </value>
- </member>
- <member name="P:NAnt.Core.ProjectSettingsLoader.NamespaceManager">
- <summary>
- Gets the <see cref="T:System.Xml.XmlNamespaceManager"/>.
- </summary>
- <value>
- The <see cref="T:System.Xml.XmlNamespaceManager"/>.
- </value>
- <remarks>
- The <see cref="P:NAnt.Core.ProjectSettingsLoader.NamespaceManager"/> defines the current namespace
- scope and provides methods for looking up namespace information.
- </remarks>
- </member>
- <member name="F:NAnt.Core.PropertyDictionary.Visiting">
- <summary>
- Constant for the "visiting" state, used when traversing a DFS of
- property references.
- </summary>
- </member>
- <member name="F:NAnt.Core.PropertyDictionary.Visited">
- <summary>
- Constant for the "visited" state, used when travesing a DFS of
- property references.
- </summary>
- </member>
- <member name="M:NAnt.Core.PropertyDictionary.#ctor(NAnt.Core.Project)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.PropertyDictionary"/>
- class holding properties for the given <see cref="P:NAnt.Core.PropertyDictionary.Project"/>
- instance.
- </summary>
- <param name="project">The project for which the dictionary will hold properties.</param>
- </member>
- <member name="M:NAnt.Core.PropertyDictionary.OnInsert(System.Object,System.Object)">
- <summary>
- Performs additional custom processes before inserting a new element
- into the <see cref="T:System.Collections.DictionaryBase"/> instance.
- </summary>
- <param name="key">The key of the element to insert.</param>
- <param name="value">The value of the element to insert.</param>
- </member>
- <member name="M:NAnt.Core.PropertyDictionary.OnRemove(System.Object,System.Object)">
- <summary>
- Performs additional custom processes before removing an element
- from the <see cref="T:System.Collections.DictionaryBase"/> instance.
- </summary>
- <param name="key">The key of the element to remove.</param>
- <param name="value">The value of the element to remove.</param>
- </member>
- <member name="M:NAnt.Core.PropertyDictionary.OnValidate(System.Object,System.Object)">
- <summary>
- Performs additional custom processes when validating the element
- with the specified key and value.
- </summary>
- <param name="key">The key of the element to validate.</param>
- <param name="value">The value of the element to validate.</param>
- </member>
- <member name="M:NAnt.Core.PropertyDictionary.AddReadOnly(System.String,System.String)">
- <summary>
- Adds a property that cannot be changed.
- </summary>
- <param name="name">The name of the property.</param>
- <param name="value">The value to assign to the property.</param>
- <remarks>
- Properties added with this method can never be changed. Note that
- they are removed if the <see cref="M:System.Collections.DictionaryBase.Clear"/> method is called.
- </remarks>
- </member>
- <member name="M:NAnt.Core.PropertyDictionary.MarkDynamic(System.String)">
- <summary>
- Marks a property as a property of which the value is expanded at
- execution time.
- </summary>
- <param name="name">The name of the property to mark as dynamic.</param>
- </member>
- <member name="M:NAnt.Core.PropertyDictionary.Add(System.String,System.String)">
- <summary>
- Adds a property to the collection.
- </summary>
- <param name="name">The name of the property.</param>
- <param name="value">The value to assign to the property.</param>
- </member>
- <member name="M:NAnt.Core.PropertyDictionary.IsReadOnlyProperty(System.String)">
- <summary>
- Determines whether the specified property is listed as read-only.
- </summary>
- <param name="name">The name of the property to check.</param>
- <returns>
- <see langword="true" /> if the property is listed as read-only;
- otherwise, <see langword="false" />.
- </returns>
- </member>
- <member name="M:NAnt.Core.PropertyDictionary.IsDynamicProperty(System.String)">
- <summary>
- Determines whether the specified property is listed as dynamic.
- </summary>
- <param name="name">The name of the property to check.</param>
- <returns>
- <see langword="true" /> if the property is listed as dynamic;
- otherwise, <see langword="false" />.
- </returns>
- </member>
- <member name="M:NAnt.Core.PropertyDictionary.Inherit(NAnt.Core.PropertyDictionary,System.Collections.Specialized.StringCollection)">
- <summary>
- Inherits properties from an existing property dictionary Instance.
- </summary>
- <param name="source">Property list to inherit.</param>
- <param name="excludes">The list of properties to exclude during inheritance.</param>
- </member>
- <member name="M:NAnt.Core.PropertyDictionary.ExpandProperties(System.String,NAnt.Core.Location)">
- <summary>
- Expands a <see cref="T:System.String"/> from known properties.
- </summary>
- <param name="input">The replacement tokens.</param>
- <param name="location">The <see cref="T:NAnt.Core.Location"/> to pass through for any exceptions.</param>
- <returns>The expanded and replaced string.</returns>
- </member>
- <member name="M:NAnt.Core.PropertyDictionary.Contains(System.String)">
- <summary>
- Determines whether a property already exists.
- </summary>
- <param name="name">The name of the property to check.</param>
- <returns>
- <see langword="true" /> if the specified property already exists;
- otherwise, <see langword="false" />.
- </returns>
- </member>
- <member name="M:NAnt.Core.PropertyDictionary.Remove(System.String)">
- <summary>
- Removes the property with the specified name.
- </summary>
- <param name="name">The name of the property to remove.</param>
- </member>
- <member name="M:NAnt.Core.PropertyDictionary.ExpandProperties(System.String,NAnt.Core.Location,System.Collections.Hashtable,System.Collections.Stack)">
- <summary>
- Expands a <see cref="T:System.String"/> from known properties.
- </summary>
- <param name="input">The replacement tokens.</param>
- <param name="location">The <see cref="T:NAnt.Core.Location"/> to pass through for any exceptions.</param>
- <param name="state">A mapping from properties to states. The states in question are "VISITING" and "VISITED". Must not be <see langword="null"/>.</param>
- <param name="visiting">A stack of properties which are currently being visited. Must not be <see langword="null"/>.</param>
- <returns>The expanded and replaced string.</returns>
- </member>
- <member name="M:NAnt.Core.PropertyDictionary.EvaluateEmbeddedExpressions(System.String,NAnt.Core.Location,System.Collections.Hashtable,System.Collections.Stack)">
- <summary>
- Evaluates the given expression string and returns the result
- </summary>
- <param name="input"></param>
- <param name="location"></param>
- <param name="state"></param>
- <param name="visiting"></param>
- <returns></returns>
- </member>
- <member name="M:NAnt.Core.PropertyDictionary.CheckDeprecation(System.String)">
- <summary>
- Checks whether the specified property is deprecated.
- </summary>
- <param name="name">The property to check.</param>
- </member>
- <member name="M:NAnt.Core.PropertyDictionary.CreateCircularException(System.String,System.Collections.Stack)">
- <summary>
- Builds an appropriate exception detailing a specified circular
- reference.
- </summary>
- <param name="end">The property reference to stop at. Must not be <see langword="null"/>.</param>
- <param name="stack">A stack of property references. Must not be <see langword="null"/>.</param>
- <returns>
- A <see cref="T:NAnt.Core.BuildException"/> detailing the specified circular
- dependency.
- </returns>
- </member>
- <member name="F:NAnt.Core.PropertyDictionary._readOnlyProperties">
- <summary>
- Maintains a list of the property names that are readonly.
- </summary>
- </member>
- <member name="F:NAnt.Core.PropertyDictionary._dynamicProperties">
- <summary>
- Maintains a list of the property names of which the value is expanded
- on usage, not at initalization.
- </summary>
- </member>
- <member name="F:NAnt.Core.PropertyDictionary._project">
- <summary>
- The project for which the dictionary holds properties.
- </summary>
- </member>
- <member name="P:NAnt.Core.PropertyDictionary.Item(System.String)">
- <summary>
- Indexer property.
- </summary>
- </member>
- <member name="P:NAnt.Core.PropertyDictionary.Project">
- <summary>
- Gets the project for which the dictionary holds properties.
- </summary>
- <value>
- The project for which the dictionary holds properties.
- </value>
- </member>
- <member name="M:NAnt.Core.Target.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Target"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Target.System#ICloneable#Clone">
- <summary>
- Creates a shallow copy of the <see cref="T:NAnt.Core.Target"/>.
- </summary>
- <returns>
- A shallow copy of the <see cref="T:NAnt.Core.Target"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Target.Clone">
- <summary>
- Creates a shallow copy of the <see cref="T:NAnt.Core.Target"/>.
- </summary>
- <returns>
- A shallow copy of the <see cref="T:NAnt.Core.Target"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Target.Execute">
- <summary>
- Executes dependent targets first, then the target.
- </summary>
- </member>
- <member name="P:NAnt.Core.Target.Executed">
- <summary>
- This indicates whether the target has already executed.
- </summary>
- </member>
- <member name="P:NAnt.Core.Target.Name">
- <summary>
- The name of the target.
- </summary>
- <remarks>
- <para>
- Hides <see cref="P:NAnt.Core.Element.Name"/> to have <see cref="T:NAnt.Core.Target"/>
- return the name of target, not the name of XML element - which
- would always be <c>target</c>.
- </para>
- <para>
- Note: Properties are not allowed in the name.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Core.Target.IfCondition">
- <summary>
- If <see langword="true" /> then the target will be executed;
- otherwise, skipped. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Target.IfDefined">
- <summary>
- Gets a value indicating whether the target should be executed.
- </summary>
- <value>
- <see langword="true" /> if the target should be executed; otherwise,
- <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.Target.UnlessCondition">
- <summary>
- Opposite of <see cref="P:NAnt.Core.Target.IfDefined"/>. If <see langword="false"/>
- then the target will be executed; otherwise, skipped. The default
- is <see langword="false"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Target.UnlessDefined">
- <summary>
- Gets a value indicating whether the target should NOT be executed.
- </summary>
- <value>
- <see langword="true" /> if the target should NOT be executed;
- otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.Target.Description">
- <summary>
- The description of the target.
- </summary>
- </member>
- <member name="P:NAnt.Core.Target.DependsListString">
- <summary>
- Space separated list of targets that this target depends on.
- </summary>
- </member>
- <member name="P:NAnt.Core.Target.Dependencies">
- <summary>
- A collection of target names that must be executed before this
- target.
- </summary>
- </member>
- <member name="M:NAnt.Core.TargetCollection.Find(System.String)">
- <summary>
- Finds a target by name.
- </summary>
- <param name="targetName">The name of the target to find.</param>
- <returns>
- The <see cref="T:NAnt.Core.Target"/> with the specified name, or
- <see langword="null"/> if no <see cref="T:NAnt.Core.Target"/> exists with
- the given name.
- </returns>
- </member>
- <member name="M:NAnt.Core.TargetCollection.ToString(System.String)">
- <summary>
- Gets the names of the targets in the <see cref="T:NAnt.Core.TargetCollection"/>
- combined into one list separated by the given <see cref="T:System.String"/>.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that contains a list of the names of the
- targets in the <see cref="T:NAnt.Core.TargetCollection"/>, separated by
- the specified <paramref name="separator"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.TargetCollection.ToString">
- <summary>
- Gets the names of the targets in the <see cref="T:NAnt.Core.TargetCollection"/>
- combined into one comma-separated list.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that contains a comma-separated list of the
- names of the targets in the <see cref="T:NAnt.Core.TargetCollection"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.TaskBuilder.#ctor(System.Reflection.Assembly,System.String)">
- <summary>
- Creates a new instance of the <see cref="T:NAnt.Core.TaskBuilder"/> class
- for the specified <see cref="T:NAnt.Core.Task"/> class in the <see cref="P:NAnt.Core.TaskBuilder.Assembly"/>
- specified.
- </summary>
- <param name="assembly">The <see cref="P:NAnt.Core.TaskBuilder.Assembly"/> containing the <see cref="T:NAnt.Core.Task"/>.</param>
- <param name="className">The class representing the <see cref="T:NAnt.Core.Task"/>.</param>
- </member>
- <member name="P:NAnt.Core.TaskBuilder.ClassName">
- <summary>
- Gets the name of the <see cref="T:NAnt.Core.Task"/> class that can be created
- using this <see cref="T:NAnt.Core.TaskBuilder"/>.
- </summary>
- <value>
- The name of the <see cref="T:NAnt.Core.Task"/> class that can be created using
- this <see cref="T:NAnt.Core.TaskBuilder"/>.
- </value>
- </member>
- <member name="P:NAnt.Core.TaskBuilder.Assembly">
- <summary>
- Gets the <see cref="P:NAnt.Core.TaskBuilder.Assembly"/> from which the task will be created.
- </summary>
- <value>
- The <see cref="P:NAnt.Core.TaskBuilder.Assembly"/> containing the task.
- </value>
- </member>
- <member name="P:NAnt.Core.TaskBuilder.TaskName">
- <summary>
- Gets the name of the task which the <see cref="T:NAnt.Core.TaskBuilder"/>
- can create.
- </summary>
- <value>
- The name of the task which the <see cref="T:NAnt.Core.TaskBuilder"/> can
- create.
- </value>
- </member>
- <member name="T:NAnt.Core.TaskBuilderCollection">
- <summary>
- Contains a strongly typed collection of <see cref="T:NAnt.Core.TaskBuilder"/> objects.
- </summary>
- </member>
- <member name="M:NAnt.Core.TaskBuilderCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.TaskBuilderCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.TaskBuilderCollection.#ctor(NAnt.Core.TaskBuilderCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.TaskBuilderCollection"/> class
- with the specified <see cref="T:NAnt.Core.TaskBuilderCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.Core.TaskBuilderCollection.#ctor(NAnt.Core.TaskBuilder[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.TaskBuilderCollection"/> class
- with the specified array of <see cref="T:NAnt.Core.TaskBuilder"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.Core.TaskBuilderCollection.Add(NAnt.Core.TaskBuilder)">
- <summary>
- Adds a <see cref="T:NAnt.Core.TaskBuilder"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.TaskBuilder"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.Core.TaskBuilderCollection.AddRange(NAnt.Core.TaskBuilder[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.TaskBuilder"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.Core.TaskBuilder"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.TaskBuilderCollection.AddRange(NAnt.Core.TaskBuilderCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.TaskBuilderCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.Core.TaskBuilderCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.TaskBuilderCollection.Contains(NAnt.Core.TaskBuilder)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.TaskBuilder"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.TaskBuilder"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.TaskBuilderCollection.Contains(System.String)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.TaskBuilder"/> for the specified
- task is in the collection.
- </summary>
- <param name="taskName">The name of task for which the <see cref="T:NAnt.Core.TaskBuilder"/> should be located in the collection.</param>
- <returns>
- <see langword="true"/> if a <see cref="T:NAnt.Core.TaskBuilder"/> for the
- specified task is found in the collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.TaskBuilderCollection.CopyTo(NAnt.Core.TaskBuilder[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.Core.TaskBuilderCollection.IndexOf(NAnt.Core.TaskBuilder)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.Core.TaskBuilder"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.TaskBuilder"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.Core.TaskBuilder"/>. If the <see cref="T:NAnt.Core.TaskBuilder"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.Core.TaskBuilderCollection.Insert(System.Int32,NAnt.Core.TaskBuilder)">
- <summary>
- Inserts a <see cref="T:NAnt.Core.TaskBuilder"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.Core.TaskBuilder"/> to insert.</param>
- </member>
- <member name="M:NAnt.Core.TaskBuilderCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.Core.TaskBuilderEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.TaskBuilderCollection.Remove(NAnt.Core.TaskBuilder)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.TaskBuilder"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.Core.TaskBuilderCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="P:NAnt.Core.TaskBuilderCollection.Item(System.String)">
- <summary>
- Gets the <see cref="T:NAnt.Core.TaskBuilder"/> for the specified task.
- </summary>
- <param name="taskName">The name of task for which the <see cref="T:NAnt.Core.TaskBuilder"/> should be located in the collection.</param>
- </member>
- <member name="T:NAnt.Core.TaskBuilderEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.Core.TaskBuilder"/> elements of a <see cref="T:NAnt.Core.TaskBuilderCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.TaskBuilderEnumerator.#ctor(NAnt.Core.TaskBuilderCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.TaskBuilderEnumerator"/> class
- with the specified <see cref="T:NAnt.Core.TaskBuilderCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.Core.TaskBuilderEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.TaskBuilderEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.Core.TaskBuilderEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.Core.TypeFactory">
- <summary>
- Comprises all of the loaded, and available, tasks.
- Use these static methods to register, initialize and create a task.
- </summary>
- </member>
- <member name="M:NAnt.Core.TypeFactory.ScanAssembly(System.String,NAnt.Core.Task)">
- <summary>
- Scans the given assembly for tasks, types, functions and filters.
- </summary>
- <param name="assemblyFile">The assembly to scan for tasks, types, functions and filters.</param>
- <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
- </member>
- <member name="M:NAnt.Core.TypeFactory.ScanAssembly(System.Reflection.Assembly,NAnt.Core.Task)">
- <summary>
- Scans the given assembly for tasks, types, functions and filters.
- </summary>
- <param name="assembly">The assembly to scan for tasks, types, functions and filters.</param>
- <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
- <returns>
- <see langword="true"/> if <paramref name="assembly"/> contains at
- least one "extension"; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.TypeFactory.ScanDir(System.String,NAnt.Core.Task,System.Boolean)">
- <summary>
- Scans the path for any task assemblies and adds them.
- </summary>
- <param name="path">The directory to scan in.</param>
- <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
- <param name="failOnError"><see cref="T:System.Boolean"/> indicating whether scanning of the directory should halt on first error.</param>
- </member>
- <member name="M:NAnt.Core.TypeFactory.AddProject(NAnt.Core.Project)">
- <summary>
- Adds any task assemblies in the project base directory
- and its <c>tasks</c> subdirectory.
- </summary>
- <param name="project">The project to work from.</param>
- </member>
- <member name="M:NAnt.Core.TypeFactory.AddProject(NAnt.Core.Project,System.Boolean)">
- <summary>
- Registers the project with <see cref="T:NAnt.Core.TypeFactory"/>, and optionally
- scan the <see cref="P:NAnt.Core.Project.BaseDirectory"/> for extension assemblies.
- </summary>
- <param name="project">The project to work from.</param>
- <param name="scan">Specified whether to scan the <see cref="P:NAnt.Core.Project.BaseDirectory"/> for extension assemblies.</param>
- </member>
- <member name="M:NAnt.Core.TypeFactory.LookupFunction(System.String,NAnt.Core.Project)">
- <summary>
- Looks up a function by name.
- </summary>
- <param name="methodName">The name of the function to lookup, including namespace prefix.</param>
- <param name="project">The <see cref="T:NAnt.Core.Project"/> in which the function is invoked.</param>
- <returns>
- A <see cref="T:System.Reflection.MethodInfo"/> representing the function, or
- <see langword="null"/> if a function with the given name does not
- exist.
- </returns>
- </member>
- <member name="M:NAnt.Core.TypeFactory.CreateTask(System.Xml.XmlNode,NAnt.Core.Project)">
- <summary>
- Creates a new <see cref="T:NAnt.Core.Task"/> instance for the given XML and
- <see cref="T:NAnt.Core.Project"/>.
- </summary>
- <param name="taskNode">The XML to initialize the task with.</param>
- <param name="proj">The <see cref="T:NAnt.Core.Project"/> that the <see cref="T:NAnt.Core.Task"/> belongs to.</param>
- <returns>
- The new <see cref="T:NAnt.Core.Task"/> instance.
- </returns>
- </member>
- <member name="M:NAnt.Core.TypeFactory.ScanTypeForTasks(System.Type,NAnt.Core.Task)">
- <summary>
- Scans a given <see cref="T:System.Type"/> for tasks.
- </summary>
- <param name="type">The <see cref="T:System.Type"/> to scan.</param>
- <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
- <returns>
- <see langword="true"/> if <paramref name="type"/> represents a
- <see cref="T:NAnt.Core.Task"/>; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.TypeFactory.ScanTypeForDataTypes(System.Type,NAnt.Core.Task)">
- <summary>
- Scans a given <see cref="T:System.Type"/> for data type.
- </summary>
- <param name="type">The <see cref="T:System.Type"/> to scan.</param>
- <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
- <returns>
- <see langword="true"/> if <paramref name="type"/> represents a
- data type; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.TypeFactory.ScanTypeForFunctions(System.Type,NAnt.Core.Task)">
- <summary>
- Scans a given <see cref="T:System.Type"/> for functions.
- </summary>
- <param name="type">The <see cref="T:System.Type"/> to scan.</param>
- <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
- <returns>
- <see langword="true"/> if <paramref name="type"/> represents a
- valid set of funtions; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.TypeFactory.ScanTypeForFilters(System.Type,NAnt.Core.Task)">
- <summary>
- Scans a given <see cref="T:System.Type"/> for filters.
- </summary>
- <param name="type">The <see cref="T:System.Type"/> to scan.</param>
- <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
- <returns>
- <see langword="true"/> if <paramref name="type"/> represents a
- <see cref="T:NAnt.Core.Filters.Filter"/>; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="P:NAnt.Core.TypeFactory.TaskBuilders">
- <summary>
- Gets the list of loaded <see cref="T:NAnt.Core.TaskBuilder"/> instances.
- </summary>
- <value>
- List of loaded <see cref="T:NAnt.Core.TaskBuilder"/> instances.
- </value>
- </member>
- <member name="P:NAnt.Core.TypeFactory.DataTypeBuilders">
- <summary>
- Gets the list of loaded <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> instances.
- </summary>
- <value>
- List of loaded <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> instances.
- </value>
- </member>
- <member name="P:NAnt.Core.TypeFactory.FilterBuilders">
- <summary>
- Gets the list of loaded <see cref="T:NAnt.Core.Filters.FilterBuilder"/> instances.
- </summary>
- <value>
- List of loaded <see cref="T:NAnt.Core.Filters.FilterBuilder"/> instances.
- </value>
- </member>
- <member name="M:NAnt.Core.ValidationException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.ValidationException"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.Core.ValidationException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.ValidationException"/>
- class with a descriptive message.
- </summary>
- <param name="message">A descriptive message to include with the exception.</param>
- </member>
- <member name="M:NAnt.Core.ValidationException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.ValidationException"/>
- class with the specified descriptive message and inner exception.
- </summary>
- <param name="message">A descriptive message to include with the exception.</param>
- <param name="innerException">A nested exception that is the cause of the current exception.</param>
- </member>
- <member name="M:NAnt.Core.ValidationException.#ctor(System.String,NAnt.Core.Location)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.ValidationException"/>
- class with a descriptive message and the location in the build file
- that caused the exception.
- </summary>
- <param name="message">A descriptive message to include with the exception.</param>
- <param name="location">The location in the build file where the exception occured.</param>
- </member>
- <member name="M:NAnt.Core.ValidationException.#ctor(System.String,NAnt.Core.Location,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.ValidationException"/>
- class with a descriptive message, the location in the build file and
- an instance of the exception that is the cause of the current
- exception.
- </summary>
- <param name="message">A descriptive message to include with the exception.</param>
- <param name="location">The location in the build file where the exception occured.</param>
- <param name="innerException">A nested exception that is the cause of the current exception.</param>
- </member>
- <member name="M:NAnt.Core.ValidationException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.ValidationException"/>
- class with serialized data.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- </member>
- <member name="M:NAnt.Core.InvalidVolumeException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.InvalidVolumeException"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.InvalidVolumeException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.InvalidVolumeException"/> class
- with a descriptive message.
- </summary>
- <param name="message">A descriptive message to include with the exception.</param>
- </member>
- <member name="M:NAnt.Core.InvalidVolumeException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.InvalidVolumeException"/> class
- with the specified descriptive message and inner exception.
- </summary>
- <param name="message">A descriptive message to include with the exception.</param>
- <param name="innerException">A nested exception that is the cause of the current exception.</param>
- </member>
- <member name="M:NAnt.Core.InvalidVolumeException.#ctor(System.Uri)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.InvalidVolumeException"/> class
- with the specified <see cref="T:System.Uri"/>.
- </summary>
- <param name="volUri"><see cref="T:System.Uri"/> of the invalid volume.</param>
- </member>
- <member name="M:NAnt.Core.InvalidVolumeException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.InvalidVolumeException"/> class
- with serialized data.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- </member>
- <member name="T:NAnt.Core.VolumeType">
- <summary>
- Represents the different types of drives that may exist in a system.
- </summary>
- </member>
- <member name="T:NAnt.Core.VolumeFlags">
- <summary>
- Represents the different supporting flags that may be set on a file system.
- </summary>
- </member>
- <member name="T:NAnt.Core.VolumeInfo">
- <summary>
- Presents information about a volume.
- </summary>
- </member>
- <member name="M:NAnt.Core.VolumeInfo.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.VolumeInfo"/> class.
- </summary>
- <remarks>
- Uses a private access modifier to prevent instantiation of this class.
- </remarks>
- </member>
- <member name="M:NAnt.Core.VolumeInfo.IsVolumeCaseSensitive(System.Uri)">
- <summary>
- Determines whether the file system is case sensitive. Performs a
- P/Invoke to the Win32 API GetVolumeInformation.
- </summary>
- <param name="uri"></param>
- <returns>
- <see langword="true" /> if the specified volume is case-sensitive;
- otherwise, <see langword="false" />.
- </returns>
- </member>
- <member name="T:NAnt.Core.XmlLogger">
- <summary>
- Used to wrap log messages in xml <message/> elements.
- </summary>
- </member>
- <member name="F:NAnt.Core.XmlLogger._projectStack">
- <summary>
- Holds the stack of currently executing projects.
- </summary>
- </member>
- <member name="M:NAnt.Core.XmlLogger.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.XmlLogger"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.XmlLogger.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.XmlLogger"/> class
- with serialized data.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- </member>
- <member name="M:NAnt.Core.XmlLogger.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates <paramref name="info"/> with the data needed to serialize
- the <see cref="T:NAnt.Core.XmlLogger"/> instance.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> to populate with data.</param>
- <param name="context">The destination for this serialization.</param>
- </member>
- <member name="M:NAnt.Core.XmlLogger.ToString">
- <summary>
- Returns the contents of log captured.
- </summary>
- </member>
- <member name="M:NAnt.Core.XmlLogger.BuildStarted(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a build has started.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- <remarks>
- This event is fired before any targets have started.
- </remarks>
- </member>
- <member name="M:NAnt.Core.XmlLogger.BuildFinished(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that the last target has finished.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- <remarks>
- This event will still be fired if an error occurred during the build.
- </remarks>
- </member>
- <member name="M:NAnt.Core.XmlLogger.TargetStarted(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a target has started.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- </member>
- <member name="M:NAnt.Core.XmlLogger.TargetFinished(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a target has finished.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- <remarks>
- This event will still be fired if an error occurred during the build.
- </remarks>
- </member>
- <member name="M:NAnt.Core.XmlLogger.TaskStarted(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a task has started.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- </member>
- <member name="M:NAnt.Core.XmlLogger.TaskFinished(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a task has finished.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- <remarks>
- This event will still be fired if an error occurred during the build.
- </remarks>
- </member>
- <member name="M:NAnt.Core.XmlLogger.MessageLogged(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a message has been logged.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- <remarks>
- Only messages with a priority higher or equal to the threshold of
- the logger will actually be output in the build log.
- </remarks>
- </member>
- <member name="M:NAnt.Core.XmlLogger.Flush">
- <summary>
- Flushes buffered build events or messages to the underlying storage.
- </summary>
- </member>
- <member name="P:NAnt.Core.XmlLogger.Threshold">
- <summary>
- Gets or sets the highest level of message this logger should respond
- to.
- </summary>
- <value>
- The highest level of message this logger should respond to.
- </value>
- <remarks>
- Only messages with a message level higher than or equal to the given
- level should be written to the log.
- </remarks>
- </member>
- <member name="P:NAnt.Core.XmlLogger.EmacsMode">
- <summary>
- Gets or sets a value indicating whether to produce emacs (and other
- editor) friendly output.
- </summary>
- <value>
- <see langword="false" /> as it has no meaning in XML format.
- </value>
- </member>
- <member name="P:NAnt.Core.XmlLogger.OutputWriter">
- <summary>
- Gets or sets the <see cref="T:System.IO.TextWriter"/> to which the logger is
- to send its output.
- </summary>
- </member>
- </members>
- </doc>
|